deckrb 0.2.2 → 0.3.0

data/README.md

@@ -29,7 +29,7 @@ Put this in a file named `meals.md`:
 
 then run this:
 
-    deck run meals.md
+    deck meals.md
 
 and you'll get a web server running on `http://localhost:4333` serving up a slide presentation with four slides:
 
@@ -65,30 +65,19 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
 
 ## Command-Line API
 
-`deck run foo.md`
+`deck foo.md`
 
  * start a local Rack server (probably Sinatra) on port 4333
  * http://localhost:4333/ serves the presentation built from `foo.md`
  * can specify multiple source files in a row
  * can also specify a showoff.json file to load multiple markdown files
 
-`deck build foo.md`
-
- * creates a static page `foo.html` in the current directory
- * unfortunately the `deck.js` source code will not be around so this won't really work yet
-
 ### Options
 
-* none yet :-)
-
-## Command-Line API (proposed)
-
-`deck build foo.md`
-
- * create a static site
- * default output dir = ./public (even if foo.md is elsewhere)
- * copies (or inlines) deck.js source
- * also copies (or inlines) "img" directory if it exists
+    --port, -p <i>:   Specify alternate port (default: 4333)
+       --build, -b:   Build an HTML file instead of launching a server (WARNING: not very useful yet)
+     --version, -v:   Print version and exit
+        --help, -h:   Show this message
 
 ## Credits
 
@@ -130,7 +119,6 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
 * command-line options (overriding or complementing config file options)
   * --output dir
   * --config deck.json
-  * --port portnum
   * --theme themename
 * more slide file types
   * Erector - `foo/bar_bar.rb` would expect `class BarBar < Deck::Slide` in there
@@ -139,7 +127,10 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
   * haml
   * tilt
 * option to render all JS and CSS inline, for a self-contained HTML doc
-  * and maybe images too, base64-encoded
+* `deck --build dir foo.md`
+  * create a self-contained static site inside dir
+  * copies (or inlines) deck.js source, generated html, and axiliary files e.g. images
+  * hell, maybe it should inline everything *including* images (using those base64 urls or whatever) into a single HTML file
 * build and push into a gh-pages branch
 * build and push into a heroku app
 * find any lines that start with a <p>.(something) and turn them into <p class="something">
@@ -156,3 +147,30 @@ and you'll get a web server running on `http://localhost:4333` serving up a slid
 * mix with keydown https://github.com/infews/keydown
 * gh-pages documentation site
 * integrate with slideshow https://github.com/geraldb/slideshow-deck.js
+
+# License
+
+The MIT License
+
+deck.js Copyright (c) 2011 Caleb Troughton
+
+deck.rb Copyright (c) 2011-12 Alex Chaffee
+
+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/bin/deck

@@ -12,15 +12,13 @@ require "deck/version"
 options = Trollop.options do
   version "deck v#{Deck::VERSION}"
   banner version
-  banner "Usage: deck [options] run [slides]"
+  banner "Usage: deck [options] [slides]"
+  banner "(see http://github.com/alexch/deck.rb README for more help)"
   opt :port, "Specify alternate port", :default => 4333
+  opt :build, "Build an HTML file instead of launching a server (WARNING: not very useful yet)"
 end
 
-command = ARGV.shift
-
-case command
-when 'build'
-
+if options[:build]
   slides = []
   output_path = nil
   output_dir = "."  # for now, since deck.js is relative to the project root
@@ -29,7 +27,6 @@ when 'build'
     # output_dir ||= File.dirname(arg)
     basename ||= File.basename(arg, ".md")
     output_path ||= "#{output_dir}/#{basename}.html"
-
     slides += Slide.from_file arg
   end
 
@@ -39,24 +36,11 @@ when 'build'
     file.write deck.to_pretty
   end
 
-when 'run'
-  
+else
+
   # Fix Rack bug https://github.com/rack/rack/issues/301
   require 'deck/rack_static_patch'
-  
   port = options[:port]
   slide_files = ARGV
   Rack::Handler.default.run Deck::RackApp.build(slide_files), :Port => port
-  
-else
-  puts "Unknown command '#{command}'"
-  puts <<-USAGE
-Usage:
-  deck run src.md...
-  deck build src.md...
-  
-see http://github.com/alexch/deck.rb README for more help.
-
-  USAGE
-  exit 1
 end

data/lib/deck/rack_app.rb

@@ -12,8 +12,11 @@ module Deck
       app_root = File.expand_path "#{here}/../.."
     end
 
-    def self.build slide_files
+    def self.public_file_server
+      Rack::File.new("#{app_root}/public")
+    end
 
+    def self.build slide_files
       if const_defined?(:Thin)
         if require "thin/logging"
           Thin::Logging.debug = true
@@ -34,7 +37,7 @@ module Deck
     def initialize slide_files
       @slide_files = [slide_files].flatten.map do |slide_file|
         case slide_file
-        when /\/?showoff.json$/
+        when /\/?showoff(.*)\.json$/
           json_file_dir = File.expand_path(File.dirname(slide_file))
           json_file = slide_file
           config = JSON.parse(File.read(json_file))
@@ -52,7 +55,7 @@ module Deck
       end.flatten
 
       @file_servers =
-        [Rack::File.new("#{::Deck::RackApp.app_root}/public")] +
+        [::Deck::RackApp.public_file_server] +
         @slide_files.map do |slide_file|
           File.expand_path File.dirname(slide_file.path) if slide_file.is_a? File
         end.compact.uniq.map do |slide_file_dir|

data/lib/deck/slide_deck.rb

@@ -43,6 +43,10 @@ module Deck
     link({:rel => "stylesheet", :href => src}.merge(attributes))
   end
 
+  def public_asset path
+    "/#{path}"
+  end
+
   def head_content
     super
     meta 'charset' => 'utf-8'
@@ -51,30 +55,30 @@ module Deck
     meta :name => "description", :content=> @description if @description
     meta :name => "author", :content=> @author if @author
 
-    stylesheet "coderay.css"
+    stylesheet public_asset("coderay.css")
 
     #  <!-- Core and extension CSS files -->
-    stylesheet "deck.js/core/deck.core.css"
+    stylesheet public_asset("deck.js/core/deck.core.css")
     extensions.each do |extension|
-      stylesheet "deck.js/extensions/#{extension}/deck.#{extension}.css"
+      stylesheet public_asset("deck.js/extensions/#{extension}/deck.#{extension}.css")
     end
 
     # <!-- Theme CSS files (menu swaps these out) -->
-    stylesheet "deck.js/themes/style/swiss.css", :id=>"style-theme-link"
+    stylesheet public_asset("deck.js/themes/style/swiss.css"), :id=>"style-theme-link"
   end
 
   def scripts
-    script :src => "deck.js/modernizr.custom.js"
+    script :src => public_asset("deck.js/modernizr.custom.js")
 
     # comment 'Grab CDN jQuery, with a protocol relative URL; fall back to local if offline'
     # script :src => '//ajax.aspnetcdn.com/ajax/jQuery/jquery-1.7.min.js'
-    script :src => 'deck.js/jquery-1.7.min.js'
+    script :src => public_asset('deck.js/jquery-1.7.min.js')
 
     comment 'Deck Core and extensions'
-    script :type => "text/javascript", :src => 'deck.js/core/deck.core.js'
+    script :type => "text/javascript", :src => public_asset('deck.js/core/deck.core.js')
 
     extensions.each do |extension|
-      script :type => "text/javascript", :src => "deck.js/extensions/#{extension}/deck.#{extension}.js"
+      script :type => "text/javascript", :src => public_asset("deck.js/extensions/#{extension}/deck.#{extension}.js")
     end
 
     # fire up deck.js

data/lib/deck/version.rb

@@ -1,3 +1,3 @@
 module Deck
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/spec/rack_app_spec.rb

@@ -73,7 +73,7 @@ module Deck
       get "/"
       assert_ok
       assert { last_response.body.include? "contents of foo.md" }
-      assert { last_response.body.include? "<script src=\"deck.js/core/deck.core.js\"" }
+      assert { last_response.body.include? "<script src=\"/deck.js/core/deck.core.js\"" }
     end
 
     it "404s anything but the root path" do
@@ -187,6 +187,8 @@ module Deck
         assert { app.slides == Slide.from_file(slide_file) }
       end
 
+      # todo: unify these tests
+
       it "reads a showoff.json file" do
         foo_file = file "foo.md", "# hello"
         bar_file = file "bar.md", "# hello"
@@ -241,6 +243,25 @@ module Deck
         }
       end
 
+      it "reads a showoff-foo.json file" do
+        foo_file = file "foo.md", "# hello"
+        bar_file = file "bar.md", "# hello"
+        showoff_file = file "showoff-foo.json", <<-JSON
+        {
+          "name": "Ruby For Programmers",
+          "description": "an introduction to the Ruby programming language",
+          "sections": [
+            "foo.md",
+            "bar.md"
+          ]
+        }
+        JSON
+
+        app = RackApp.new [showoff_file]
+        assert { app.slides == Slide.from_file(foo_file) + Slide.from_file(bar_file) }
+      end
+
+
       it "if no slides are specified, it globs all markdown files under ."
 
     end

data/spec/slide_deck_spec.rb

@@ -21,7 +21,7 @@ module Deck
 
   it "renders a basic deck.js HTML page" do
     assert { doc }
-    assert { @html.include? '<link href="deck.js/core/deck.core.css" rel="stylesheet" />' }
+    assert { @html.include? '<link href="/deck.js/core/deck.core.css" rel="stylesheet" />' }
   end
 
   it "contains a single dummy slide" do

metadata

@@ -1,147 +1,155 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: deckrb
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
 platform: ruby
-authors: 
+authors:
 - Alex Chaffee
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erector
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3107287963
-        segments: 
-        - 0
-        - 9
-        - 0
-        - pre
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.0.pre1
-  prerelease: false
-  requirement: *id001
-  name: erector
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        version: "2"
   prerelease: false
-  requirement: *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0.pre1
+- !ruby/object:Gem::Dependency
   name: redcarpet
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
   prerelease: false
-  requirement: *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
   name: rack
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id004
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: trollop
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id005
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: coderay
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id007
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: json
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id008
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rack-codehighlighter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-description: deck.js (http://imakewebthings.github.com/deck.js) is a JavaScript library for building slide presentations using HTML 5. deck.rb (http://github.com/alexch/deck.rb) builds on top of deck.js, adding some features and letting you focus on your slides, not the HTML infrastructure.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: deck.js (http://imakewebthings.github.com/deck.js) is a JavaScript library
+  for building slide presentations using HTML 5. deck.rb (http://github.com/alexch/deck.rb)
+  builds on top of deck.js, adding some features and letting you focus on your slides,
+  not the HTML infrastructure.
 email: alex@stinky.com
-executables: 
+executables:
 - deck
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - lib/deck/noko.rb
 - lib/deck/rack_app.rb
 - lib/deck/rack_static_patch.rb
@@ -223,41 +231,39 @@ files:
 - spec/slide_deck_spec.rb
 - spec/slide_spec.rb
 - spec/spec_helper.rb
-- bin/deck
+- !binary |-
+  YmluL2RlY2s=
 homepage: http://github.com/alexch/deck
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1200341781470137723
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1200341781470137723
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Make HTML slide shows; wraps deck.js
-test_files: 
+test_files:
 - spec/javascripts/support/jasmine_config.rb
 - spec/javascripts/support/jasmine_runner.rb
 - spec/rack_app_spec.rb