trickster 0.0.4 → 0.0.5

data/.gitignore

@@ -0,0 +1,16 @@
+doc
+src
+images
+html
+*.sw?
+pkg
+.jhw-cache
+coverage
+.bundle
+tmp
+cruddo.rdoc
+gli.wiki
+Gemfile.lock
+results.html
+.rbx
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@trickster --create

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.rdoc

@@ -9,7 +9,7 @@ JavaScript, which will dynamically resize each slide to the biggest it can be ba
 
 == Presentation Format
 
-Your presentation is stored in text file.  Each slide has the following format:
+Your presentation is stored in a text file.  Each slide has the following format:
 
     !<slide_type>: options
     <content>
@@ -53,11 +53,11 @@ transition:: number of milliseconds to transition to the *next* slide.  The defa
 The first line is the "title" if this slide, rendered in an +H1+.  The remaining are bullets.  If a bullet line is preceded with a <tt>*</tt>, <tt>-</tt>, or <tt>+</tt>, that bullet character is omitted automatically.
 
 == IMAGE
-The first line is the url to the image to show.
+The first line is the url to the image to show.  Trickster will size the image down only if it is too big, preserving its aspect ratio.
 
 == CODE
 
-If the first line starts with <tt>file://</tt>, the contents of this file is read in as the contents of the code block.  Otherwise, the entire contents of the slide is verbatim put into a +pre+ and then +code+ block.  Syntax highlighting is done using a modified version of +highlight.js+.  This modification demarcates each line of the code, and allows you to show line numbers and callout particular lines.
+If the first line starts with <tt>file://</tt>, the contents of this file is read in as the contents of the code block.  Otherwise, the entire contents of the slide is verbatim put into a +pre+ and then +code+ block.  Syntax highlighting is done using +highlight.js+.
 
 === Language
 
@@ -74,6 +74,14 @@ A code slide accepts an option of +callout+ which is a comma-delimited list of t
 
 Further, if the line number is preceded with a dash (e.g. <tt>-3</tt>), that line will be styled for strikethrough, in addition to being highlighed.  This is useful to show lines of code that are going to be deleted based on whatever you are talking about.
 
+=== Highlighting Themes
+
+Trickster comes with all the themes provided by highlight.js, as well a customizable theme in SCSS.  When you create your slideshow, use <tt>--theme</tt> to specify the syntax highlighting theme.  <code>trickster help init</code> will show the list of themes available.
+
+If you want easily create a custom highlighting scheme, the theme +custom+ generates a SASS template with variables to allow you to easily set the colors you want.
+
+Once your slideshow has been created, you can change the theme via <code>trickster update theme</code>. <strong>This is destructive</strong> so make sure your slideshow is checked into version control.
+
 == COMMANDLINE
 
 This slide is for showing command-line invocations and results. It is assumed to start with a CLI invocation and that such invocations are followed by results, that can be many lines.  When you present the slideshow, the command will be output in a "typewriter" style, after which the result will be shown automatically, with each command acting like a "bullet" to be revealed.
@@ -105,7 +113,7 @@ The second, and more useful, point of customization is +styles.css+ or +styles.s
 
 * Prefer 'em' over explicit sizes, as this will aloww your sizing choices to work at any size (remember that Trickster tries to fit your content to the screen)
 * The <tt>BODY</tt> element will be given the class of the currently-displayed slide, so if you want to, for example, change the background color of a slide based on its type, apply styles to <tt>body.SLIDE_TYPE</tt> and not <tt>section.SLIDE_TYPE</tt>
-* The syntax highlighting is woefully tied to Solarized Light.  Since we are using a patched version of highlight.js that shows line numbers and calls out lines, I had to patch the syntax CSS file to show those highlights.  I've currently only done so for Solarized Light, and this style is hard-coded in the generated HTML file, anway.  Sorry.  Feel free to improve this for me and I'll commit the patch.
+* If you want to customzie the syntax highlighting, you can.  <tt>trickster update</tt> will leave it alone.  If you want to build a more invovled highlighting theme, use the "custom" theme when you create your presentation or migrate to it via <tt>trickster update theme -t custom</tt>
 
 == Delivering the Presentation
 
@@ -113,7 +121,7 @@ Simply open `index.html` in your browser.  Your browser should be Safari or Chro
 
 Every time you reload, the presentation will be dynamically sized to the size of the browser, so you should configure your browser and monitor to the size of your presentation, then reload.
 
-Occasionally, Trickster will size the slides too larger or too small.  In that case, you can use "-" and "+" to resize the slides on the fly.  If you reload, the sizes will be reset.
+Occasionally, Trickster will size the slides too larger or too small.  In that case, you can use "-" and "+" to resize the slides on the fly.  Note that if you you reload, the sizes will be reset.
 
 === Keyboard Commands
 
@@ -131,7 +139,7 @@ Trickster discourages verbose slides with lots of text or lots of bullets. This
 
 == trickster - Bootstrap, generate, and manage your trickster presentation
 
-v0.0.4
+v0.0.5
 
 === Global Options
 === --help
@@ -185,16 +193,52 @@ 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
+Note that if you upgrade trickster, you should run `trickster update` in your slide directory
 to get the latest JavaScript and CSS files.
+===== Options
+===== -t arg
+
+Specify the syntax highlighting theme to use.  One of arta, ascetic, brown_paper, custom, dark, default, far, github, googlecode, idea, ir_black, magula, monokai, pojoaque, rainbow, school_book, solarized_dark, solarized_light, sunburst, tomorrow, tomorrow-night, tomorrow-night-blue, tomorrow-night-bright, tomorrow-night-eighties, vs, xcode, zenburn.  Use 'custom' to get an scss file you can easily customize.
+
+[Aliases] --theme
+[Default Value] default
+[Must Match] ["arta", "ascetic", "brown_paper", "custom", "dark", "default", "far", "github", "googlecode", "idea", "ir_black", "magula", "monokai", "pojoaque", "rainbow", "school_book", "solarized_dark", "solarized_light", "sunburst", "tomorrow", "tomorrow-night", "tomorrow-night-blue", "tomorrow-night-bright", "tomorrow-night-eighties", "vs", "xcode", "zenburn"]
+
+
 ==== update [dir_name]
-Update an existing slideshow with the latest Trickster JS/CSS files
+Update your slideshow with files provided by trickster
+
+
+
+===== Commands
+====== files slide_dir
+Update the trickster JS/CSS files when you've updated the trickster gem
 
 
 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.
+  slideshow is entirely self-contained, when you upgrade trickster, 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.
+====== theme slide_dir
+Update the syntax-highlighting theme for your presentation
+
+
+A normal 'trickster update' will leave your theme.css alone, since you can customize it.  This will overwrite
+  your existing theme.css with the theme from trickster that you specify.  You should check your presentation
+  into source control to avoid the destructive nature of this command.
+======= Options
+======= -t slide_dir
+
+Specify the syntax highlighting theme to use.  One of arta, ascetic, brown_paper, custom, dark, default, far, github, googlecode, idea, ir_black, magula, monokai, pojoaque, rainbow, school_book, solarized_dark, solarized_light, sunburst, tomorrow, tomorrow-night, tomorrow-night-blue, tomorrow-night-bright, tomorrow-night-eighties, vs, xcode, zenburn.  Use 'custom' to get an scss file you can easily customize.
+
+[Aliases] --theme
+[Default Value] default
+[Must Match] ["arta", "ascetic", "brown_paper", "custom", "dark", "default", "far", "github", "googlecode", "idea", "ir_black", "magula", "monokai", "pojoaque", "rainbow", "school_book", "solarized_dark", "solarized_light", "sunburst", "tomorrow", "tomorrow-night", "tomorrow-night-blue", "tomorrow-night-bright", "tomorrow-night-eighties", "vs", "xcode", "zenburn"]
+A normal 'trickster update' will leave your theme.css alone, since you can customize it.  This will overwrite
+  your existing theme.css with the theme from trickster that you specify.  You should check your presentation
+  into source control to avoid the destructive nature of this command.
 
-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.
+[Default Command] files

data/Rakefile

@@ -0,0 +1,120 @@
+require 'rake/clean'
+require 'bundler'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Bundler::GemHelper.install_tasks
+
+CLEAN << "test/slideshow/index.html"
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+CLOBBER << 'tmp/aruba'
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+
+task :jasmine do |t|
+  unless system("jasmine-headless-webkit -j test/jasmine.yml")
+    exit -1
+  end
+end
+CLOBBER << ".jhw-cache"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc 'Add CSS markup to the theme files for callouts'
+task 'patch_css' do
+  Dir["css/themes-orig/*.css"].each do |original_css_file|
+    new_css_file = "css/themes/" + File.basename(original_css_file)
+    background = nil
+    opacity = nil
+    look_for_background = false
+    File.open(new_css_file,'w') do |new_file|
+      File.open(original_css_file).readlines.each do |line|
+        new_file.puts line
+
+        if look_for_background
+          if line =~ /background-color: (.*);/
+            background = $1;
+            look_for_background = false
+          elsif line =~ /background: (.*);/
+            background = $1;
+            look_for_background = false
+          elsif line =~ /opacity: (.*);/
+            opacity = $1;
+            look_for_background = false
+          end
+        end
+
+        if line =~ /^pre .tex .formula {/
+          look_for_background = true
+        end
+      end
+      string = <<EOS
+pre {
+  counter-reset: lines;
+}
+pre .line {
+  counter-increment: lines;
+}
+pre .line::before {
+  content: counter(lines); text-align: right;
+  display: inline-block; width: 2em;
+  padding-right: 0.5em; margin-right: 0.5em;
+  color: #eee8d5;
+}
+
+pre .line-callout::before {
+  content: '\\2192'; text-align: right;
+  display: inline-block; width: 2em;
+  padding-right: 0.5em; margin-right: 0.5em;
+  color: #002b36;
+}
+
+.lines-callout {
+  border-radius: 0.25em;
+  padding-top: 0.15em;
+  padding-bottom: 0.15em;
+}
+
+.lines-callout {
+  padding-top: 0.1em;
+  padding-bottom: 0.1em;
+  #{background.nil? ? opacity.nil? ? '/* Could not determine background for callouts */' : ("opacity: " + opacity + ";") : ("background: " + background + ";")}
+}
+EOS
+      new_file.puts string
+    end
+    puts "Migrated #{original_css_file}"
+  end
+end
+
+task :default => [:test,:jasmine,:features]

data/TODO

@@ -0,0 +1,4 @@
+* Have executable generate a bundle instead of running it out this dir
+* Implement 'watch' to regenerate
+* Implement 'init' to boostrap bundle
+* SASS

data/bin/trickster

@@ -7,10 +7,23 @@ require 'fileutils'
 
 include GLI::App
 
+BASE_DIR = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+
+THEMES = Dir[File.join(BASE_DIR,'css','themes') + "/*.css",
+             File.join(BASE_DIR,'css','themes') + "/*.scss"].map { |file| 
+  File.basename(file).gsub(/\.css$/,'').gsub(/\.scss/,'') 
+}.sort
+
 program_desc 'Bootstrap, generate, and manage your trickster presentation'
 
 version Trickster::VERSION
 
+def add_theme_flag(command)
+  command.desc "Specify the syntax highlighting theme to use.  One of #{THEMES.join(', ')}.  Use 'custom' to get an scss file you can easily customize."
+  command.default_value 'default'
+  command.flag [:t,:theme], :must_match => THEMES
+end
+
 desc 'Create a new trickster presentation'
 long_desc <<EOS
 This will create a completely self-contained presentation that can be run just from the files
@@ -21,11 +34,14 @@ 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
+Note that if you upgrade trickster, you should run `trickster update` in your slide directory
 to get the latest JavaScript and CSS files.
 EOS
 arg_name 'dir_name'
 command :init do |c|
+
+  add_theme_flag(c)
+
   c.action do |global_options,options,args|
     dir = args.shift
     FileUtils.mkdir(dir)
@@ -55,40 +71,66 @@ class YourCode
 
 end
 EOF
-      base = File.expand_path(File.join(File.dirname(__FILE__),'..'))
 
-      copier = Trickster::FileCopier.new(base,dir)
-      copier.copy_files('js','js')
-      copier.copy_files('js/lib','js')
-      copier.copy_files('css','css')
+      file_copier = Trickster::FileCopier.new(BASE_DIR,dir)
+      file_copier.copy_files('js','js')
+      file_copier.copy_files('js/lib','js')
+      file_copier.copy_files('css','css')
+
+      theme_copier = Trickster::ThemeCopier.new(BASE_DIR,dir)
+      theme_copier.copy_theme(options[:theme])
 
       puts "Your slideshow is ready, run trickster build to build it"
     end
   end
 end
 
-desc 'Update an existing slideshow with the latest Trickster JS/CSS files'
-long_desc <<EOS
-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.
-EOS
+desc 'Update your slideshow with files provided by trickster'
 arg_name '[dir_name]'
 command :update do |c|
-  c.action do |global_options,options,args|
-    dir = args.shift
-    dir = '.' if dir.nil?
-    base = File.expand_path(File.join(File.dirname(__FILE__),'..'))
 
-    copier = Trickster::FileCopier.new(base,dir)
-    copier.copy_files('js','js', :except => "custom.js")
-    copier.copy_files('js/lib','js')
-    copier.copy_files('css','css', :except => "styles.css")
+  c.desc "Update the trickster JS/CSS files when you've updated the trickster gem"
+  c.long_desc <<-EOS
+  Run this after you've upgraded trickster and want to get the latest features.  Since your 
+  slideshow is entirely self-contained, when you upgrade trickster, 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.
+  EOS
+  c.arg_name 'slide_dir'
+  c.command :files do |files_command|
+    files_command.action do |global_options,options,args|
+      dir = args.shift
+      dir = '.' if dir.nil?
+
+      copier = Trickster::FileCopier.new(BASE_DIR,dir)
+      copier.copy_files('js','js', :except => "custom.js")
+      copier.copy_files('js/lib','js')
+      copier.copy_files('css','css', :except => "styles.css")
+    end
   end
+
+  c.desc 'Update the syntax-highlighting theme for your presentation'
+  c.long_desc <<-EOS
+  A normal 'trickster update' will leave your theme.css alone, since you can customize it.  This will overwrite
+  your existing theme.css with the theme from trickster that you specify.  You should check your presentation
+  into source control to avoid the destructive nature of this command.
+  EOS
+  c.arg_name 'slide_dir'
+  c.command :theme do |theme_command|
+    add_theme_flag(theme_command)
+
+    theme_command.action do |global_options,options,args|
+      dir = args.shift
+      dir = '.' if dir.nil?
+      theme_copier = Trickster::ThemeCopier.new(BASE_DIR,dir)
+      theme_copier.copy_theme(options[:theme])
+    end
+  end
+
+  c.default_command :files
 end
 
 desc 'Generate the presentation from your slides'

data/css/themes-orig/arta.css

@@ -0,0 +1,155 @@
+/*
+Date: 17.V.2011
+Author: pumbur <pumbur@pumbur.net>
+*/
+
+pre code
+{
+  display: block; padding: 0.5em;
+  background: #222;
+}
+
+pre .profile .header *,
+pre .ini .title,
+pre .nginx .title
+{
+  color: #fff;
+}
+
+pre .comment,
+pre .javadoc,
+pre .preprocessor,
+pre .preprocessor .title,
+pre .shebang,
+pre .profile .summary,
+pre .diff,
+pre .pi,
+pre .doctype,
+pre .tag,
+pre .template_comment,
+pre .css .rules,
+pre .tex .special
+{
+  color: #444;
+}
+
+pre .string,
+pre .symbol,
+pre .diff .change,
+pre .regexp,
+pre .xml .attribute,
+pre .smalltalk .char,
+pre .xml .value,
+pre .ini .value,
+pre .clojure .attribute
+{
+  color: #ffcc33;
+}
+
+pre .number,
+pre .addition
+{
+  color: #00cc66;
+}
+
+pre .built_in,
+pre .literal,
+pre .vhdl .typename,
+pre .go .constant,
+pre .go .typename,
+pre .ini .keyword,
+pre .lua .title,
+pre .perl .variable,
+pre .php .variable,
+pre .mel .variable,
+pre .django .variable,
+pre .css .funtion,
+pre .smalltalk .method,
+pre .hexcolor,
+pre .important,
+pre .flow,
+pre .inheritance,
+pre .parser3 .variable
+{
+  color: #32AAEE;
+}
+
+pre .keyword,
+pre .tag .title,
+pre .css .tag,
+pre .css .class,
+pre .css .id,
+pre .css .pseudo,
+pre .css .attr_selector,
+pre .lisp .title,
+pre .clojure .built_in,
+pre .winutils,
+pre .tex .command,
+pre .request,
+pre .status
+{
+  color: #6644aa;
+}
+
+pre .title,
+pre .ruby .constant,
+pre .vala .constant,
+pre .parent,
+pre .deletion,
+pre .template_tag,
+pre .css .keyword,
+pre .objectivec .class .id,
+pre .smalltalk .class,
+pre .lisp .keyword,
+pre .apache .tag,
+pre .nginx .variable,
+pre .envvar,
+pre .bash .variable,
+pre .go .built_in,
+pre .vbscript .built_in,
+pre .lua .built_in,
+pre .rsl .built_in,
+pre .tail,
+pre .avrasm .label,
+pre .tex .formula,
+pre .tex .formula *
+{
+  color: #bb1166;
+}
+
+pre .yardoctag,
+pre .phpdoc,
+pre .profile .header,
+pre .ini .title,
+pre .apache .tag,
+pre .parser3 .title
+{
+  font-weight: bold;
+}
+
+pre .coffeescript .javascript,
+pre .xml .javascript,
+pre .xml .css,
+pre .xml .cdata
+{
+  opacity: 0.6;
+}
+
+pre code,
+pre .javascript,
+pre .css,
+pre .xml,
+pre .subst,
+pre .diff .chunk,
+pre .css .value,
+pre .css .attribute,
+pre .lisp .string,
+pre .lisp .number,
+pre .tail .params,
+pre .container,
+pre .haskell *,
+pre .erlang *,
+pre .erlang_repl *
+{
+  color: #aaa;
+}