trickster 0.0.4 → 0.0.5

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/features/update.feature

@@ -0,0 +1,33 @@
+Feature: I can update my slideshow after I upgrade trickster
+  Since the slideshow is self-contained
+  I need a way to get the latest features of trickster
+
+  Scenario Outline: Can update a slideshow
+    Given a slideshow in "test_slideshow"
+    And the JS files and CSS files in "test_slideshow" are out-of-date
+    When I cd to "test_slideshow"
+    And I successfully run `trickster update <args>`
+    Then the JS files and CSS files in "test_slideshow" should be up-to-date
+    And a file named "css/theme.css" should exist
+    But "css/styles.css" in "test_slideshow" should not have been touched
+    And "js/custom.js" in "test_slideshow" should not have been touched
+    And "css/theme.css" in "test_slideshow" should not have been touched
+
+    Examples:
+      | args  |
+      |       |
+      | files |
+
+  Scenario: Can update the theme
+    Given a slideshow in "test_slideshow"
+    And the JS files and CSS files in "test_slideshow" are out-of-date
+    When I cd to "test_slideshow"
+    And I successfully run `trickster update theme`
+    Then "css/theme.css" in "test_slideshow" should be identical to "default.css"
+
+  Scenario: Can update the theme
+    Given a slideshow in "test_slideshow"
+    And the JS files and CSS files in "test_slideshow" are out-of-date
+    When I cd to "test_slideshow"
+    And I successfully run `trickster update theme -t github`
+    Then "css/theme.css" in "test_slideshow" should be identical to "github.css"

data/js/trickster.js

@@ -44,7 +44,7 @@ var TricksterLoader = function(config,functions) {
       if ($(this).attr("data-strikeouts")) {
         var strikes = $(this).attr("data-strikeouts").split(",");
         for(var index in strikes) {
-          var line = parseInt(strikes[index]) - 1;
+          var line = parseInt(strikes[index]);
           $(this).find(".line-" + line).css("text-decoration","line-through");
         }
       }

data/lib/trickster.rb

@@ -6,4 +6,6 @@ require 'trickster/renderer/commandline_renderer'
 require 'trickster/renderer/normal_renderer'
 require 'trickster/renderer/image_renderer'
 require 'trickster/slide_renderer'
+require 'trickster/copier'
 require 'trickster/file_copier'
+require 'trickster/theme_copier'

data/lib/trickster/copier.rb

@@ -0,0 +1,11 @@
+module Trickster
+  # Base copier for copying files from the trickster install to the slideshow location
+  class Copier
+    # 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
+  end
+end

data/lib/trickster/file_copier.rb

@@ -1,12 +1,5 @@
 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
-
+  class FileCopier < Copier
     # Shallow copies all files from +from+ with the given extension
     #
     # from:: location, relative to @install_root where files are copied from

data/lib/trickster/renderer/code_renderer.rb

@@ -3,21 +3,58 @@ module Trickster
     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>"
+        content = wrap_lines_with_callouts(content,options)
+        io.puts "<pre><code #{language(options)}data-strikeouts='#{strikes(options)}' data-callout-lines='#{callouts(options)}'>#{content}</code></pre>"
       end
 
     private
 
-    def read_file_if_content_is_filename(content)
-      if content[0] =~ /file:\/\/(.*$)/
-        File.open($1).readlines.map(&:chomp)
-      else
-        content
+      def wrap_lines_with_callouts(content,options)
+        i = 0
+        callout_lines = callout_option(options).map(&:abs)
+        previous_line_called_out = false
+        marked_up_lines = ""
+        stop_callout_block = "";
+        content.each_with_index do |line,i|
+          callout_class = '';
+          start_callout_block = "";
+          stop_callout_block = "";
+
+          if callout_lines.include?(i+1)
+            callout_class = "line-callout";
+            if !previous_line_called_out
+              start_callout_block = "<div class='lines-callout'>";
+            end
+            previous_line_called_out = true
+          else
+            if previous_line_called_out
+              stop_callout_block = "</div>";
+            end
+            previous_line_called_out = false;
+          end
+          marked_up_lines += stop_callout_block
+          stop_callout_block = ""
+          marked_up_lines += start_callout_block
+          marked_up_lines += "<span class='line line-#{i+1} #{callout_class}' >"
+          marked_up_lines += line
+          marked_up_lines += "</span>\n"
+        end
+        if previous_line_called_out
+          stop_callout_block = "</div>";
+        end
+        marked_up_lines = marked_up_lines.gsub(/\n$/,'')
+        marked_up_lines += stop_callout_block
+        marked_up_lines.gsub(/\n$/,'')
       end
-    end
-    
+
+      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]+)/

data/lib/trickster/theme_copier.rb

@@ -0,0 +1,16 @@
+module Trickster
+  class ThemeCopier < Copier
+    # Copies the theme from the trickster install into the @destination_root
+    def copy_theme(theme)
+      extension = %w(.css .scss).find { |extension| File.exists?(trickster_css_file(theme,extension)) }
+      destination_file = File.join(@destination_root,'css','theme' + extension)
+      FileUtils.cp trickster_css_file(theme,extension),destination_file
+    end
+
+  private
+
+    def trickster_css_file(theme,extension)
+      (File.join(@install_root,'css','themes',theme + extension))
+    end
+  end
+end

data/lib/trickster/version.rb

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

data/notes.txt.md

@@ -0,0 +1,56 @@
+# trickster - create and present a nice presentation, quickly
+
+trickster allows you to do a few things:
+
+* Author a presentation in Markdown instead of a GUI
+* Allow anyone to connect to your laptop to view the presentation on their screen
+* Have a "presenter view" either in another window or another device
+
+
+## Authoring
+
+Authoring is just like showoff; you create a `showoff.json` and various
+markdown slides; this gets turned into your presentation
+
+### Themeing
+
+Each presentation comes witha `styles.css` that handles all themeing.  You can 
+tweak this or try others that exist
+
+## Presenting
+
+You can present just as with showoff, by doing screen mirroring and
+driving the presentation off.  OR, you can get the "speakers view"
+in another window or device and drive the presentation that way.
+
+- use showoff-style source; showoff.json and markdown slides in showoff format
+- pml-style callout to code
+- ability to highlight/reveal code
+- clean styles for easy themeing
+- default theme handles:
+  - sublists
+  - blockquotes
+- Presentation works standalone or connected to presenter
+- Get static version
+- Get PDF version
+
+Present
+
+- presentations in-progress connect to server
+- presenter connects to server and can send commands to presentation
+    - forward
+    - back
+    - arbitrary slide
+    - laser pointer
+- should work on an iPad
+- TIMER
+
+# Questions
+
+* Why not just beef up showoff?
+  * Well, this is for me to learn node and showoff is a Sinatra app
+  * showoff is also kinda hacked up over the years, and there's no tests
+* CLI?
+  * Ruby - quick and easy via GLI, but requires an extra dep to install
+  * JavaScript - less to install, but probably suck to implement
+* Markdown for JS?

data/test/jasmine.yml

@@ -0,0 +1,4 @@
+src_dir: "js"
+spec_dir: "test/js"
+src_files:
+  - "**/*.js"

data/test/js/bullets_spec.js

@@ -0,0 +1,82 @@
+describe("Bullets",function() {
+  var originalJQuery = $;
+  afterEach(function() {
+    $ = originalJQuery;
+  });
+  function makeCurrentSlideFunction(size) {
+    return function() {
+      return {
+        children: function() {
+          return {
+            find: function() {
+              return {
+                size: function() { return size; }
+              };
+            }
+          };
+        }
+      };
+    };
+  }
+  it("initially has bullets to advance if there is at least one bulleted item",function() {
+    var bullets = TricksterBullets(makeCurrentSlideFunction(1),{});
+
+    expect(bullets.hasBulletsToAdvanceFirst()).toBe(true);
+  });
+  it("initially has NO bullets to advance if there are no bulleted items",function() {
+    var bullets = TricksterBullets(makeCurrentSlideFunction(0),{});
+
+    expect(bullets.hasBulletsToAdvanceFirst()).toBe(false);
+  });
+
+  describe("LI bullets",function() {
+    it("sets the next LI to be visible when we advance",function() {
+      var visible = "none";
+      var advanced = false;
+      var currentSlide = function() {
+        return {
+          children: function() {
+            return {
+              find: function(selector) {
+                return {
+                  eq: function(index) {
+                    if (index == 0) {
+                      return {
+                        0: {
+                          tagName: "LI"
+                        },
+                        css: function(cssAttribute,value) {
+                          if ( (cssAttribute == "visibility")  && value ) {
+                            visible = value;
+                            advanced = visible == "visible";
+                          }
+                        }
+                      };
+                    }
+                    else {
+                      return {};
+                    }
+                  },
+                  size: function() {
+                    if (advanced) {
+                      return 0;
+                    }
+                    else {
+                      return 1;
+                    }
+                  }
+                };
+              },
+            };
+          }
+        };
+      };
+      var bullets = TricksterBullets(currentSlide,{});
+
+      bullets.advanceToNextBullet();
+
+      expect(bullets.hasBulletsToAdvanceFirst()).toBe(false);
+      expect(visible).toBe("visible");
+    });
+  });
+});

data/test/js/sizer_spec.js

@@ -0,0 +1,244 @@
+describe("Sizer",function() {
+  var originalJQuery = $;
+  afterEach(function() {
+    $ = originalJQuery;
+  });
+  /** Returns an element that will behavior more or less like the jquery element
+   * that we'd use in the browser */
+  function makeElement(initialWidth,initialHeight,cssClass) {
+    return {
+      w           : initialWidth,
+      h           : initialHeight,
+      0           : {
+        scrollWidth: this.w,
+        scrollHeight: this.h,
+      },
+      findInternal: function() {
+        return {
+          length: 0,
+          each: function() {}
+        };
+      },
+      find        : function() { return this.findInternal(); },
+      fontSizes   : [16],
+      marginTops  : [0],
+      hasClass    : function(classToCheck) {
+        if (cssClass) {
+          return classToCheck == cssClass;
+        }
+        else {
+          return false;
+        }
+      },
+      cssInternal : function(cssAttribute,value) {
+        if (cssAttribute == "font-size") {
+          if (value) {
+            this.fontSizes.push(value);
+            this.w = initialWidth * parseInt(value);
+            this.h = initialHeight * parseInt(value);
+          }
+          else {
+            return this.fontSizes[this.fontSizes.length - 1] + "px";
+          }
+        }
+        else if ( (cssAttribute == "margin-top") && value) {
+          this.marginTops.push(value);
+        }
+      },
+      css         : function(cssAttribute, value) { return this.cssInternal(cssAttribute,value); },
+      width       : function() { return this.w; },
+      height      : function() { return this.h; }
+    };
+  }
+  var sizeFunction = Sizer.sizeFunction(1024,768);
+
+  describe("non code/commandline slide",function() {
+    it("resizes a square object",function() {
+      var element = makeElement(10,10);
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(4);
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(38);
+    });
+
+    it("resizes a tall object",function() {
+      var element = makeElement(10,100);
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(3); // hits max early
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(26);
+    });
+
+    it("resizes a wide object",function() {
+      var element = makeElement(100,10);
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(4);
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(38);
+    });
+  });
+  describe("BULLETS slide",function() {
+    it("resizes a square object",function() {
+      var element = makeElement(10,10,"BULLETS");
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(4);
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(76);
+    });
+
+    it("resizes a tall object",function() {
+      var element = makeElement(10,100,"BULLETS");
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(3); // hits max early
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(26);
+    });
+
+    it("resizes a wide object",function() {
+      var element = makeElement(100,10,"BULLETS");
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(4);
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(76);
+    });
+  });
+  describe("CODE slide",function() {
+    it("shrinks if it there was word-wrapping",function() {
+      $ = function(element) {
+        if (typeof(element) == "number") {
+          return {
+            height: function() { return element; }
+          };
+        }
+        else {
+          return {};
+        }
+      };
+
+      var element = makeElement(200,80,"CODE");
+
+      var calls = 0;
+      var callsUntilWrappingStops = 10;
+      element["find"] = function(selector) {
+        if (selector == ".line") {
+          return {
+            length: 4,
+            each: function(f) {
+              if (calls < callsUntilWrappingStops) {
+                f(0,12);
+                f(1,12);
+                f(2,24);
+                f(3,12);
+              }
+              else {
+                f(0,12);
+                f(1,12);
+                f(2,12);
+                f(3,12);
+              }
+              calls = calls + 1;
+            }
+          };
+        }
+        else {
+          return this.findInternal();
+        }
+      };
+      element["css"] = function(cssAttribute,value) {
+        if ((cssAttribute == "font-size") && value) {
+          this.fontSizes.push(value);
+          this.w = 10 * parseInt(value);
+          this.h = parseInt(value) + this.fontSizes.length;
+        }
+        else {
+          return this.cssInternal(cssAttribute,value);
+        }
+      }
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(25 - callsUntilWrappingStops);
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(666);
+      expect(element.marginTops[element.marginTops.length - 1]).toBe(-666);
+    });
+    it("resizes a square object",function() {
+      var element = makeElement(10,10,"CODE");
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(4);
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(76);
+      expect(element.marginTops[element.marginTops.length - 1]).toBe(-76);
+    });
+
+    it("resizes a tall object",function() {
+      var element = makeElement(10,100,"CODE");
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(3); // hits max early
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(26);
+      expect(element.marginTops[element.marginTops.length - 1]).toBe(-26);
+    });
+
+    it("resizes a wide object",function() {
+      var element = makeElement(100,10,"CODE");
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(4);
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(76);
+      expect(element.marginTops[element.marginTops.length - 1]).toBe(-76);
+    });
+  });
+  describe("COMMANDLINE slide",function() {
+    it("resizes sets display inline before resizing, then restoring it back to display none",function() {
+      var element = makeElement(10,10,"COMMANDLINE");
+      element["displays"] = [];
+      element["css"] = function(cssAttribute,value) {
+        if ( (cssAttribute == "display") && value) {
+          this.displays.push(value);
+        }
+        else {
+          return this.cssInternal(cssAttribute,value);
+        }
+      };
+      element["find"] = function(selector) {
+        if (selector == ".cli-element") {
+          return {
+            length: 1,
+            each: function(f) {
+              f(0,element);
+            }
+          };
+        }
+        else {
+          return this.findInternal();
+        }
+      };
+      $ = function(elt) {
+        if (elt == element) {
+          return element;
+        }
+        else {
+          return {};
+        }
+      };
+
+      sizeFunction(element);
+
+      expect(element.fontSizes.length).toBe(4);
+      expect(element.displays.length).toBe(2);
+      expect(element.displays[0]).toBe("inline");
+      expect(element.displays[1]).toBe("none");
+      expect(element.fontSizes[element.fontSizes.length - 1]).toBe(76);
+      expect(element.marginTops[element.marginTops.length - 1]).toBe(-76);
+    });
+  });
+});