reveal-ck 0.1.0

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "reveal.js"]
+        path = reveal.js
+        url = git://github.com/hakimel/reveal.js.git

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/.rvmrc

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+environment_id="ruby-1.9.3-p327@reveal-ck"
+
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gem 'haml'
+gem 'gli'
+gem 'rake'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'jeweler'
+  gem 'rspec'
+  gem 'bundler'
+  gem 'cucumber'
+  gem 'aruba'
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.5.1)
+      childprocess (~> 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.1.4)
+    childprocess (0.3.7)
+      ffi (~> 1.0, >= 1.0.6)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    diff-lcs (1.1.3)
+    ffi (1.3.1)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
+    git (1.2.5)
+    gli (2.5.4)
+    haml (3.1.7)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.6)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler
+  cucumber
+  gli
+  haml
+  jeweler
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jed Northridge, http://jednorthridge.com
+
+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/README.md

@@ -0,0 +1,103 @@
+# reveal-ck: a [reveal.js](http://lab.hakim.se/reveal-js/) construction kit
+
+## Overview
+
+The goal of this project is let you quickly author
+[reveal.js](http://lab.hakim.se/reveal-js/) presentations.
+
+It enables you to author reveal.js-aware-[haml](http://haml.info/) that
+can conveniently be transformed into slides.
+
+The hope is that you will be able to leverage all of the power,
+beauty, and functionality that comes from reveal.js while focusing
+entirely on the actual content and ideas you are trying to get across.
+
+This content will usually take the form of:
+
+* A file containing your slides (```slides.haml```)
+* A directory containing any images you'd like to reference relatively
+  (```images```).
+
+And, in return for this, you will be able to create slides that can be
+placed anywhere on the web (or kept locally). As with all
+[reveal.js](http://lab.hakim.se/reveal-js/) presentations, you can
+show these to other people on an iPhone, iPad, or present them in your
+browser.
+
+Here's an example of the inputs you'd provide:
+https://github.com/jedcn/talk-learning-with-tools
+
+Here's an example of the output you'd get: Coming Soon
+
+For a full sampling of everything
+[reveal.js](http://lab.hakim.se/reveal-js/) can do, take a look at the
+[live demo](http://lab.hakim.se/reveal-js/).
+
+## Getting Started
+
+At present, we assume you've got a functional Ruby 1.9.x environment
+up and running.
+
+If that's the case, try the following:
+
+* clone this project
+* run a ```bundle```
+* run ```reveal-ck```
+
+At this point, the sample ```slides.haml``` that came with the project
+will be transformed into a set of slides. You can see the result by
+opening up ```slides/index.html``` in your browser.
+
+If you've made it this far, you've got the basic basic functionality
+up and running.
+
+## Authoring Slides
+
+Now that you are assured of basic functionality, start making changes
+and customizing ```slides.haml```. Once you've made a change you'd
+like to see, re-run ```reveal-ck``` and then re-open (or refresh) ```slides/index.html```
+
+[reveal.js](http://lab.hakim.se/reveal-js/) has a great
+[live demo](http://lab.hakim.se/reveal-js/), and if you take a look at
+the source in the demo, you can get up and running quickly with things
+that can be placed into your ```slides.haml```.
+
+## Why not just clone reveal.js?
+
+Or why not use http://www.rvl.io/ which offers a WYSIWYG experience?
+
+You can! For sure.
+
+The whole reveal.js offering is great.
+
+If reveal-ck's approach is too contrived or doesn't warrant the setup
+time, skip it!
+
+## Then.. why would anyone use reveal-ck?
+
+The thought behind this project to help you focus on what *you* want
+to say.
+
+For me, focusing becomes easier and my thoughts clearer when I reduce
+the list of slides to a single file (```slides.haml```). It only
+contains the slide content I am presenting and there's minimal markup.
+
+HAML isn't the most readable thing (say, compared to markdown), but it
+is decent and sharing or reviewing something like ```slides.haml``` is
+easier than reviewing the final presentation:
+
+* If you look at the presentation in a browser, you can't scan all of
+  the slides at once. You need to visit them. If you're looking at
+  ```slides.haml``` you can quickly scan through 30+ slides.
+
+* If you look at the html behind the presentation (say, view source),
+  there's a bunch of stuff that makes the magic happen: styles,
+  javascript, etc.
+
+Finally, if you track your slides in a system like git, you can get
+meaningful diffs between versions of ```slides.haml```. This is
+slightly easier than if you track the generated presentation.
+
+In the end, the presentation framework,
+[reveal.js](http://lab.hakim.se/reveal-js/), can make things pretty,
+but only you can make a presentation that is worthwhile.

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rake/clean'
+require_relative 'lib/reveal-ck'
+task :default => [ :spec, :cucumber ]

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/reveal-ck

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'reveal-ck'
+
+# Setup rake and load needed parts of rakelib so that rake tasks can be
+# invoked programmatically
+require 'rake'
+rakelib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'rakelib'))
+load File.join(rakelib, 'presentation.rake')
+
+include GLI::App
+
+program_desc 'A reveal.js construction kit'
+
+version RevealCK::VERSION
+
+desc 'Generate reveal.js slides'
+arg_name 'Tranforms your slides.haml into a presentation'
+command :generate do |c|
+  c.action do |global_options,options,args|
+    Rake::Task['presentation'].invoke
+  end
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/features/generate.feature

@@ -0,0 +1,63 @@
+Feature: Generate slides
+
+  In order to easily generate reveal.js presentations
+  As a user of reveal-ck
+  I want to use the "reveal-ck generate" command
+
+  Scenario: Generating basic slides
+    Given a file named "slides.haml" with:
+    """
+    %section
+      %h1
+        Made with RevealCK
+      %p.small
+        oh yeah!
+    """
+    When I run `reveal-ck generate`
+    Then the exit status should be 0
+    And the following files should exist:
+    | slides.html       |
+    | slides/index.html |
+    And the file "slides.html" should contain exactly:
+    """
+    <section>
+      <h1>
+        Made with RevealCK
+      </h1>
+      <p class='small'>
+        oh yeah!
+      </p>
+    </section>
+
+    """
+    And the file "slides/index.html" should contain:
+    """
+    <section>
+      <h1>
+        Made with RevealCK
+      </h1>
+      <p class='small'>
+        oh yeah!
+      </p>
+    </section>
+    """
+
+  Scenario: Generating slides with images
+    Given a file named "images/ruby100.png" that's a copy of "data/images/ruby100.png"
+    And a file named "slides.haml" with:
+    """
+    %section
+      %img{ alt: 'Ruby Logo', src: 'images/ruby100.png' }
+    """
+    When I run `reveal-ck generate`
+    Then the exit status should be 0
+    And the following files should exist:
+    | slides.html               |
+    | slides/index.html         |
+    | slides/images/ruby100.png |
+    And the file "slides/index.html" should contain:
+    """
+    <section>
+      <img alt='Ruby Logo' src='images/ruby100.png' />
+    </section>
+    """

data/features/help.feature

@@ -0,0 +1,18 @@
+Feature: Getting Command Line Help
+
+  reveal-ck provides general command line help to a user so that she
+  understands what it does and is aware of the commands and options.
+
+  Scenario: Show general help if reveal-ck is run without options
+    When I run `reveal-ck`
+    Then it should pass with:
+    """
+    help     - Shows a list of commands or help for one command
+    """
+
+  Scenario: Show general help if reveal-ck is run with --help
+    When I run `reveal-ck --help`
+    Then it should pass with:
+    """
+    help     - Shows a list of commands or help for one command
+    """

data/features/step_definitions/file_management_steps.rb

@@ -0,0 +1,3 @@
+Given /^a file named "(.*?)" that's a copy of "(.*?)"$/ do |dest, src|
+  copy_file_under_features src, dest
+end

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/support/file_management.rb

@@ -0,0 +1,16 @@
+# Absolute path of reveal-ck/features
+def features_dir
+  File.expand_path(File.join(File.dirname(__FILE__), '..'))
+end
+
+# Support for easily copying any file underneath features to a new
+# location. Presumed to be helpful for copying around test data stored
+# at reveal-ck/features/data.
+def copy_file_under_features(rel_features_file, dest_file)
+  abs_features_file = File.join features_dir, rel_features_file
+  in_current_dir do
+    dest_dir = File.dirname dest_file
+    FileUtils.mkdir_p(dest_dir) unless File.directory?(dest_dir)
+    FileUtils.cp abs_features_file, dest_dir
+  end
+end

data/lib/reveal-ck.rb

@@ -0,0 +1,4 @@
+require_relative 'reveal-ck/version'
+require_relative 'reveal-ck/file_slicer'
+require_relative 'reveal-ck/file_splicer'
+require_relative 'reveal-ck/haml_processor'

data/lib/reveal-ck/file_slicer.rb

@@ -0,0 +1,23 @@
+class FileSlicer
+
+  def self.remove!(path, range)
+    slice_file = if File.exists? path
+      path
+    else
+      File.expand_path(File.join(Dir.pwd, path))
+    end
+    lines = File.open(slice_file).readlines
+    slicer = FileSlicer.new lines
+    sliced_lines = slicer.remove range
+    File.open(slice_file, 'w') { |f| f << sliced_lines.join }
+  end
+
+  def initialize(lines)
+    @lines = lines
+  end
+
+  def remove(range)
+    @lines.select.with_index { |line, index| ! range.cover? index }
+  end
+
+end