shining 1.3.5 → 1.3.6

data/CHANGELOG.txt

@@ -1,4 +1,9 @@
-= 1.3.5
+= 1.3.6
+
+* slide steps, so you can progressively show content.
+* deploying to Heroku now tries to use the presentation's name as the application name.
+
+= 1.3.5 (20/06/2010)
 
 * image loading now won't screw with the stage positioning.
 * slide styles loading now works again. Fuck my specless life.

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Julio Cesar Ody
+
+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/Rakefile

@@ -26,6 +26,7 @@ begin
     gem.add_dependency      'json_pure',      '>= 1.1.9'
     gem.add_dependency      'heroku',         '>= 1.9.9'
     gem.add_dependency      'rack',           '>= 0.9'
+    gem.add_dependency      'stringex',       '>= 1.1.0'
     gem.add_dependency      'jeweler',        '>= 1.4.0'
     gem.add_development_dependency 'rspec', '1.3.0'
     gem.add_development_dependency 'jspec', '4.2.0'    

data/TODO.txt

@@ -10,8 +10,6 @@
 - themes
   * add a white theme.
 - optimization
-  * bundling of CSS and JS.
   * rely more on events so duplicate code is eliminated.
-  * perhaps bundle at the rackup file level?
 - spec/tests
   * write my own test suite for this app.

data/VERSION

@@ -1 +1 @@
-1.3.5
+1.3.6

data/bin/shine

@@ -3,16 +3,18 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'shining'
+require 'stringex'
 include Shining::FileMethods
 
 ACTIONS   = {
-  :new_on!            => ['build'],
-  :new_slide!         => ['slide'],
-  :help_and_exit!     => ['help', '-h', '--help'],
-  :play               => ['play', 'go'],
-  :deploy             => ['deploy'],
-  :remove             => ['remove', 'delete', 'rm'],
-  :version            => ['version', '-v']
+  :new_on!        => ['build'],
+  :new_slide!     => ['slide'],
+  :help_and_exit! => ['help', '-h', '--help'],
+  :play           => ['play', 'go'],
+  :deploy         => ['deploy'],
+  :remove         => ['remove', 'delete', 'rm'],
+  :version        => ['version', '-v'],
+  :start          => ['go', 'start']
 }
 
 def bail! reason
@@ -64,14 +66,16 @@ def new_slide! name, format = 'html'
 end
 
 def play
-  preso = Shining::Preso.open Dir.pwd
-  player = Shining::Player.new preso
+  preso   = Shining::Preso.open Dir.pwd
+  player  = Shining::Player.new preso
   player.go!
 end
 
 def deploy name = nil
-  preso = Shining::Preso.open Dir.pwd
-  Shining::Heroku.deploy preso, name
+  preso   = Shining::Preso.open(Dir.pwd)
+  heroku  = Shining::Heroku.new preso
+  name ||= preso.name.to_url
+  heroku.deploy name
 end
 
 def remove slide
@@ -83,4 +87,11 @@ def version
   Shining.say Shining::VERSION
 end
 
+def start port = 4567
+  preso = Shining::Preso.open Dir.pwd
+  raise "Cannot find the rackup command in your path. Make sure Rack is installed!" if `which rackup`.empty?
+  puts "Shining started on port #{port}."
+  `rackup -p #{port}` 
+end
+
 figure_what_to_do!

data/css/base.css

@@ -28,6 +28,8 @@ ul    { display: inline-block; margin-left: 2em }
 #stage > * { text-rendering: optimizeLegibility }
 a          { cursor: pointer }
 
+.step { display: none }
+
 div.slice { position: absolute; display: block; width: 0; top: -10px; bottom: -10px }
 
 #help {

data/lib/shining.js

@@ -1,3 +1,6 @@
+// Shining - http://shining.heroku.com
+// Copyright (c) 2010 Julio Cesar Ody - See LICENSE.txt 
+
 (function($) {
   var KEY = { SPACE: 32, RIGHT: 39, LEFT: 37 };
 
@@ -54,18 +57,8 @@
     // public methods
     firstSlide:     function() { getSlide(Shining.slides.first()) },
     lastSlide:      function() { getSlide(Shining.slides.last() ) },
-    nextSlide:      function() {
-      if (Shining.slides.next()) {
-        document.location.hash = Shining.slides.next();
-        trigger('next');
-      }
-    },
-    previousSlide:  function() {
-      if (Shining.slides.previous()) {
-        document.location.hash = Shining.slides.previous();
-        trigger('previous');
-      }
-    },
+    nextSlide:      function() { if (Shining.slides.next()) { trigger('next') } },
+    previousSlide:  function() { if (Shining.slides.previous()) { trigger('previous') } },
     getSlide:       function(slide) { getSlide(slide) },
     help:     help,
     init:     init,
@@ -197,9 +190,7 @@
     $(window).resize(function() { centerStage() });
     $(document).ready(function() {
       bindKeys();
-      when('previous',  function() { help('←') });
-      when('next',      function() { help('→') });
-      when('slideplay', function() { loadSlideStyle(arguments[1]) });
+      bindEvents();
       $(window).bind('hashchange', function(event) {
         var slide = document.location.hash.replace('#', '');
         if (slide) { Shining.getSlide(slide) };
@@ -344,6 +335,22 @@
       }
     })
   }
+
+  function bindEvents() {
+    when('previous',  function() { 
+      help('←');
+      document.location.hash = Shining.slides.previous();
+    });
+    when('next',      function() { 
+      help('→');
+      if ($('#stage .step:not(:visible)').length) {
+        $('#stage .step:not(:visible):first').show()
+      } else {
+        document.location.hash = Shining.slides.next();
+      }
+    });
+    when('slideplay', function() { loadSlideStyle(arguments[1]) });
+  }
   
   function centerStage() {
     var top = ($(window).height() - $('#stage').outerHeight()) / 2;

data/lib/shining.rb

@@ -23,12 +23,12 @@ module Shining
     end
     
     def say something
-      STDOUT.puts(something) unless quiet?
+      STDOUT.puts something unless quiet?
       yield if block_given?
     end
 
     def error message
-      STDERR.puts message
+      STDERR.puts message unless quiet?
     end
 
     def root

data/lib/shining/heroku.rb

@@ -1,26 +1,59 @@
-# Class that handles deploying a presentation to Heroku.
-# This is REALLY hard to spec, so I just won't. I'm sure you can forgive me.
+# Handles deploying a presentation to Heroku.
+require 'heroku'
+require 'heroku/command'
 
 module Shining
 
 class Heroku
   extend FileMethods
-  class << self
-    def deploy preso, name
-      check_for_git_and_heroku
-      copy Shining.root/'lib'/'config.ru', preso.path
-      change_dir preso.path
-      `git init && git add . && git commit -m 'heroku deploy'`
-      `heroku create #{name}`
-      `git push heroku master`
-      Shining.say "Done!"
+  class FailCreatingApp < RuntimeError; end
+  
+  def initialize preso
+    raise RuntimeError, 'Git is either not installed or not in your PATH. Check and try again.' if `which git`.empty?
+    @preso  = preso
+    @client = ::Heroku::Command.run_internal 'auth:client', []
+  end
+  
+  def create_app name = preso.name
+    Shining.say "\tCreating #{name} on Heroku..."
+    begin
+      @client.create name
+      change_dir @preso.path
+      `git remote add heroku git@#{@client.host}:#{name}.git`
+    rescue RestClient::RequestFailed => error
+      case error.http_code
+      when 422
+        Shining.error "\tApparently #{name} already exists on Heroku. Try again with a different name."
+      else
+        Shining.error "\tAn error ocurred when creating #{name}. Maybe try again in a moment?"
+      end
+      raise FailCreatingApp
     end
+  end
     
-    private
-    def check_for_git_and_heroku
-      raise RuntimeError, 'You need to install the heroku gem before deploying! (Usually "sudo gem install heroku")' if `which heroku`.empty?
-      raise RuntimeError, 'Git is either not installed or not in your PATH. Check and try again.' if `which git`.empty?
+  def deploy name
+    copy Shining.root/'lib'/'config.ru', @preso.path
+    change_dir @preso.path
+    Shining.say "Creating Git repository on #{@preso.path}" do `git init` end unless git_repo?
+    Shining.say "Updating presentation's contents" do
+      `git add .`
+      system "git commit -a -m 'heroku deploy'"
     end
+    create_app(name) unless heroku_app?
+    Shining.say "Pushing to Heroku" do
+      system "git push heroku master"
+    end
+    Shining.say "Done! Visit http://#{name}.heroku.com to browse your presentation."
+    Shining.say "If you're updating, make sure you do a hard refresh (shift + refresh on most modern browsers)."
+  end
+  
+  private  
+  def git_repo?
+    dir? Dir.pwd/'.git'
+  end  
+  
+  def heroku_app?
+    `git remote`.split("\n").include? 'heroku'
   end
 end
 

data/lib/shining/preso.rb

@@ -5,7 +5,7 @@ module Shining
 
 class Preso
   include FileMethods and extend FileMethods
-  attr_accessor :path
+  attr_reader :path, :name
 
   SLIDE_FORMATS     = %w(haml markdown html)
 
@@ -16,7 +16,8 @@ class Preso
       copy_templates
       vendorize!
     end
-    @config = json(@path/'config.json')      
+    @config = json(@path/'config.json')
+    @name   = @config['title']
   end
 
   def self.open dir
@@ -48,10 +49,10 @@ class Preso
     new_file path/'slides'/"#{name}.js"   if options[:with].include?('script') rescue nil
     config['slides'] << file and save_config!
   end
-  
+
   def remove_slide file
     file = basename(file)
-    name, format = basename(file, extname(file)), extname(file).sub(/^./, '')    
+    name, format = basename(file, extname(file)), extname(file).sub(/^./, '')
     delete! file
     delete! "#{name}.css"
     delete! "#{name}.js"

data/shining.gemspec

@@ -5,20 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shining}
-  s.version = "1.3.5"
+  s.version = "1.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julio Cesar Ody"]
-  s.date = %q{2010-06-21}
+  s.date = %q{2010-07-12}
   s.default_executable = %q{shine}
   s.description = %q{HTML + CSS + Javascript = awesome presos}
   s.email = %q{julio.ody@gmail.com}
   s.executables = ["shine"]
   s.extra_rdoc_files = [
-    "README.markdown"
+    "LICENSE.txt",
+     "README.markdown"
   ]
   s.files = [
     "CHANGELOG.txt",
+     "LICENSE.txt",
      "README.markdown",
      "Rakefile",
      "TODO.txt",
@@ -51,7 +53,7 @@ Gem::Specification.new do |s|
      "shining.gemspec",
      "spec/cli_spec.rb",
      "spec/filemethods_spec.rb",
-     "spec/generators_spec.rb",
+     "spec/heroku_spec.rb",
      "spec/javascripts/dom.html",
      "spec/javascripts/rhino.js",
      "spec/javascripts/sample/config.json",
@@ -92,7 +94,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/cli_spec.rb",
      "spec/filemethods_spec.rb",
-     "spec/generators_spec.rb",
+     "spec/heroku_spec.rb",
      "spec/preso_spec.rb",
      "spec/shining_spec.rb",
      "spec/spec_helper.rb"
@@ -106,6 +108,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<json_pure>, [">= 1.1.9"])
       s.add_runtime_dependency(%q<heroku>, [">= 1.9.9"])
       s.add_runtime_dependency(%q<rack>, [">= 0.9"])
+      s.add_runtime_dependency(%q<stringex>, [">= 1.1.0"])
       s.add_runtime_dependency(%q<jeweler>, [">= 1.4.0"])
       s.add_development_dependency(%q<rspec>, ["= 1.3.0"])
       s.add_development_dependency(%q<jspec>, ["= 4.2.0"])
@@ -114,6 +117,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<json_pure>, [">= 1.1.9"])
       s.add_dependency(%q<heroku>, [">= 1.9.9"])
       s.add_dependency(%q<rack>, [">= 0.9"])
+      s.add_dependency(%q<stringex>, [">= 1.1.0"])
       s.add_dependency(%q<jeweler>, [">= 1.4.0"])
       s.add_dependency(%q<rspec>, ["= 1.3.0"])
       s.add_dependency(%q<jspec>, ["= 4.2.0"])
@@ -123,6 +127,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<json_pure>, [">= 1.1.9"])
     s.add_dependency(%q<heroku>, [">= 1.9.9"])
     s.add_dependency(%q<rack>, [">= 0.9"])
+    s.add_dependency(%q<stringex>, [">= 1.1.0"])
     s.add_dependency(%q<jeweler>, [">= 1.4.0"])
     s.add_dependency(%q<rspec>, ["= 1.3.0"])
     s.add_dependency(%q<jspec>, ["= 4.2.0"])

data/spec/heroku_spec.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Shining::Heroku do  
+  context "initializing" do
+    it "checks if Git is in the binaries path" do
+      old_path = ENV['PATH']
+      ENV['PATH'] = ""
+      lambda do Shining::Heroku.new(@preso) end.should raise_error
+      ENV['PATH'] = old_path
+    end
+    
+    it "instances a new Heroku::Client" do
+      Heroku::Command.should_receive(:run_internal).with('auth:client', []).and_return(mock_heroku_client)
+      Shining::Heroku.new @preso
+    end
+  end  
+end

data/spec/preso_spec.rb

@@ -1,17 +1,6 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe Shining::Preso do
-  before :all do
-    TMP = Dir.tmpdir/'shining-tmp' unless defined?(TMP)
-    FileUtils.rm_rf   TMP
-    FileUtils.mkdir_p TMP
-  end
-
-  before :each do
-    FileUtils.rm_rf TMP/'temp'
-    @preso = Shining::Preso.new TMP/'temp'
-  end
-
   context '#new' do
     it "creates a folder for the presentation on #new" do
       File.directory?(TMP/'temp').should be_true
@@ -29,7 +18,7 @@ describe Shining::Preso do
   
   context "#open" do
     it "opens an existing presentation" do
-      @preso.should be_an_instance_of(Shining::Preso)
+      @preso.should be_an_instance_of Shining::Preso
     end
     
     it "errors out if the directory is not a Shining presentation" do
@@ -82,4 +71,8 @@ describe Shining::Preso do
   it "returns a list of the presentation's slides" do
     @preso.slides.should include('welcome.html')
   end
+  
+  it "returns the preso's name on #name" do
+    @preso.name.should == "Your presentation"
+  end
 end

data/spec/sample/config.json

@@ -1,4 +1,5 @@
 {
   "slides":       ["first", "second", "third"],
-  "transitions":  false
+  "transitions":  false,
+  "title":        "Light and shadow"
 }

data/spec/spec_helper.rb

@@ -2,9 +2,25 @@ require 'rubygems'
 require 'tmpdir'
 require File.join(File.dirname(__FILE__), *%w(.. lib shining))
 
-gem 'rspec',      '>= 1.3.0';    require 'spec'
+gem 'rspec',      '= 1.3.0';    require 'spec'
 gem 'rake',       '>= 0.8.7';    require 'rake'
 gem 'json_pure',  '>= 1.1.9';    require 'json/pure'
-gem 'haml',       '>= 2.2.17';   require 'haml'
 
-Shining.quiet!
+Shining.quiet!
+
+def mock_heroku_client
+  zemock = mock Heroku::Client, :host => 'heroku.com', :password => 'foo', :user => 'bar'
+end
+
+Spec::Runner.configure do |config|
+  config.before :all do
+    TMP = Dir.tmpdir/'shining-tmp' unless defined?(TMP)
+    FileUtils.rm_rf   TMP
+    FileUtils.mkdir_p TMP
+  end
+
+  config.before :each do
+    FileUtils.rm_rf TMP/'temp'
+    @preso = Shining::Preso.new TMP/'temp'
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shining
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 1
   - 3
-  - 5
-  version: 1.3.5
+  - 6
+  version: 1.3.6
 platform: ruby
 authors: 
 - Julio Cesar Ody
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-21 00:00:00 +10:00
+date: 2010-07-12 00:00:00 +10:00
 default_executable: shine
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,9 +66,25 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: stringex
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -80,11 +96,11 @@ dependencies:
         - 0
         version: 1.4.0
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -96,11 +112,11 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: jspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -112,11 +128,11 @@ dependencies:
         - 0
         version: 4.2.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -128,7 +144,7 @@ dependencies:
         - 7
         version: 0.8.7
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 description: HTML + CSS + Javascript = awesome presos
 email: julio.ody@gmail.com
 executables: 
@@ -136,9 +152,11 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE.txt
 - README.markdown
 files: 
 - CHANGELOG.txt
+- LICENSE.txt
 - README.markdown
 - Rakefile
 - TODO.txt
@@ -171,7 +189,7 @@ files:
 - shining.gemspec
 - spec/cli_spec.rb
 - spec/filemethods_spec.rb
-- spec/generators_spec.rb
+- spec/heroku_spec.rb
 - spec/javascripts/dom.html
 - spec/javascripts/rhino.js
 - spec/javascripts/sample/config.json
@@ -240,7 +258,7 @@ summary: HTML + CSS + Javascript = awesome presos
 test_files: 
 - spec/cli_spec.rb
 - spec/filemethods_spec.rb
-- spec/generators_spec.rb
+- spec/heroku_spec.rb
 - spec/preso_spec.rb
 - spec/shining_spec.rb
 - spec/spec_helper.rb