reveal-ck 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzEyM2QwYjU3YTliMGZkYzJmYzdlMjUxNDI2NzA3ZmI0MjAyNzBjMw==
-  data.tar.gz: !binary |-
-    NDQwNWUwYmI3YzUyMTA4NzAwMDg2YmEzYWIxYWM0M2E5YzQxMjYxNQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YWJmODY1YjNhNTZlZmNhMTZlMmY5YTA5M2JiMzFlZWE1ZGZlN2EyODMzZDU0
-    MDU3Y2NhNTBkYzk3NWJiNWFlZGZkNGQ5YTVlMTVkMjE3OTJmNzFlM2FlMmEw
-    NTE0ZjAwY2QzMjk4MDAyYzQ1N2U2MDZiYWY3NGI3ZTRmYWZkNWY=
-  data.tar.gz: !binary |-
-    YjYzMWU5MWE1NjU5ZDZiMjlkYzJiNTM5ODQ2MmQ4OTFiOWIyYWQ4MDA4NGE1
-    ZGM5YmQ5NDIxOTBiMjQ4NjFhOTk4MzJjNDRmZGVhMjFmZTYxMDM5YWFhZDM0
-    ZmNiYjVmMmZiZTk1NzkyNTk4MmU4MTY5NDRlM2I0ZjAzMDEwMTA=
+SHA1:
+  metadata.gz: 1f86a3c2fb07f07cc93f5ba5e78d505f0f3a94cd
+  data.tar.gz: 5b9197c6a1fbd564ed20329357f879c60feeb246
+SHA512:
+  metadata.gz: 3cf370cd8cd3bf83b78cbc4f878c096579d32dad04098cda3754e18da67d11202f97182c6a927262028f9a89b32b4d87258ed5ee9a42ce0c4f10120191963ade
+  data.tar.gz: b45e6ad9c6f594dc31905f3d314f48e469cdeb92e8e47589c0c8abe347ec50b6aa4e1105687f6dbee58bf5409b6084a45b7cced314c67dc489e443ba76db092a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Jed Northridge, http://jednorthridge.com
+Copyright (c) 2013-2014 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
@@ -17,4 +17,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,10 +1,35 @@
-# reveal-ck: Make Slides with Ruby
+# Make Slides with a Quickness
 
-This project lets you author slides with a Ruby toolset.
+reveal-ck lets you author [reveal.js][reveal.js] presentations with
+popular markup and templating languages.
 
-You write in Haml or Slim or Ruby. The end result
-[looks like this][reveal.js].
+You write in Markdown, Textile, Haml, Slim or Ruby itself.
 
-Introduction available at http://jedcn.github.io/reveal-ck.
+## A Written Introduction
+
+..is available at http://jedcn.github.io/reveal-ck.
+
+## If you'd prefer short videos,
+
+*An Introduction* (4 mins):
+
+<a href='https://vimeo.com/jedcn/reveal-ck-introduction'>
+  <img alt="Video Thumbnail" width="306" height="178" src='https://raw2.github.com/jedcn/reveal-ck/gh-pages/images/reveal-ck-introduction-thumbnail.png' />
+</a>
+
+*Getting Started with Markdown* (6 mins):
+
+<a href='https://vimeo.com/jedcn/reveal-ck-getting-started'>
+  <img alt="Video Thumbnail" width="306" height="178" src='https://raw2.github.com/jedcn/reveal-ck/gh-pages/images/reveal-ck-getting-started-thumbnail.png' />
+</a>
+
+*Stop! Haml Time!* (14 mins):
+
+<a href='https://vimeo.com/jedcn/reveal-ck-stop-haml-time'>
+  <img alt="Video Thumbnail" width="306" height="178" src='https://raw2.github.com/jedcn/reveal-ck/gh-pages/images/reveal-ck-stop-haml-time-thumbnail.png' />
+</a>
+
+[![Build Status][travis]](https://travis-ci.org/jedcn/reveal-ck)
+[![Code Climate][code-climate]](https://codeclimate.com/github/jedcn/reveal-ck)
 
 [reveal.js]:    http://lab.hakim.se/reveal-js

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'rubygems'
 
 require 'bundler'
@@ -8,10 +7,10 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
-require 'rake'
-require 'rake/clean'
-task :default => [ :spec, :cucumber, :quality ]
+task default: :ci
+
+task test: [:spec, :cucumber]

data/bin/reveal-ck

@@ -8,93 +8,77 @@ program_desc 'A reveal.js construction kit'
 
 version RevealCK::VERSION
 
-desc 'Generate reveal.js slides'
-command :generate do |c|
-
-  # Where is the slides file?
-  default_file = 'slides.md'      if File.exists? 'slides.md'
-  default_file = 'slides.textile' if File.exists? 'slides.textile'
-  default_file = 'slides.haml'    if File.exists? 'slides.haml'
-  default_file = 'slides.slim'    if File.exists? 'slides.slim'
-  default_file = 'slides.rb'      if File.exists? 'slides.rb'
-  c.desc 'The file containing your slides'
-  c.flag [:f, :file], default_value: default_file
-
-  c.action do |global_options, options, args|
-    slides_file = options[:file]
-
-    require 'rake' # for FileList
-    image_files = FileList['images/**/*']
-
-    output_dir = 'slides'
-
-    presentation = RevealCK::Presentation.load slides_file
-
-    presentation
-      .merge_config({ file: 'config.yml' }) if File.exists?('config.yml')
-
-    puts "Generating slides for '#{slides_file}'.."
-
-    builder =
-      RevealCK::Builders::PackagedSlides.new({
-                                               image_files: image_files,
-                                               output_dir: output_dir,
-                                               presentation: presentation
-                                             })
-    builder.build!
+class RevealCKExecutable
+  desc 'Generate reveal.js slides'
+  command :generate do |c|
+
+    slide_files = FileList['slides.*']
+    default_file = slide_files.empty? ? nil : slide_files.first
+
+    c.desc 'The file containing your slide content'
+    c.flag [:f, :file], default_value: default_file
+
+    c.desc 'The directory to place your generated slides in'
+    c.flag [:d, :dir], default_value: 'slides'
+
+    c.action do |_, options, _|
+      slides_file = options[:file]
+      if slides_file.nil?
+        puts
+        puts 'Problem:'
+        puts
+        puts '  reveal-ck could not find a slides file, and it cannnot build'
+        puts '  your presentation without one.'
+        puts
+        puts '  It thinks anything that matches "slides.*" is a slides file.'
+        puts
+        puts '  Some examples are: slides.md, slides.html, slides.haml'
+        puts
+        msg = 'Create a file matching slides.* to proceed, such as slides.md.'
+        exit_now!(msg)
+      end
+      puts "Generating slides for '#{slides_file}'.."
+      builder_args = {
+        reveal_js_dir: RevealCK.path_to('reveal.js'),
+        reveal_ck_dir: Dir.pwd,
+        output_dir: options[:dir],
+        slides_file: options[:file]
+      }
+      slides_builder =
+        RevealCK::Builders::SlidesBuilder.new(builder_args)
+      slides_builder.prepare
+      slides_builder.build
+    end
   end
-end
-
-desc 'Start webserver so slides are available via http'
-command :serve, :server do |c|
-
-  c.desc 'The directory to serve up'
-  c.flag [:d, :dir], default_value: 'slides'
 
-  c.desc 'The port to serve on'
-  c.flag [:p, :port], default_value: 10000
-
-  c.action do |global_options, options, args|
-    dir = options[:dir]
-    port = options[:port]
-
-    require 'webrick'
-    server = WEBrick::HTTPServer.new :Port => port, :DocumentRoot => dir
-    trap('INT') { server.shutdown }
-
-    puts ""
-    puts ""
-    puts "\tServing up slide content in '#{dir}/'."
-    puts ""
-    puts "\tOpen your browser to 'http://localhost:#{port}'."
-    puts ""
-    puts "\tPress CTRL-C to stop serving slides."
-    puts ""
-    puts ""
-    server.start
+  desc 'Start webserver so slides are available via http'
+  command :serve, :server do |c|
+
+    c.desc 'The directory to serve up'
+    c.flag [:d, :dir], default_value: 'slides'
+
+    c.desc 'The port to serve on'
+    c.flag [:p, :port], default_value: 10_000
+
+    c.action do |_, options, _|
+      dir = options[:dir]
+      port = options[:port]
+
+      require 'webrick'
+      server = WEBrick::HTTPServer.new Port: port, DocumentRoot: dir
+      trap('INT') { server.shutdown }
+
+      puts
+      puts
+      puts "\tServing up slide content in '#{dir}/'."
+      puts
+      puts "\tOpen your browser to 'http://localhost:#{port}'."
+      puts
+      puts "\tPress CTRL-C to stop serving slides."
+      puts
+      puts
+      server.start
+    end
   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
+  exit run(ARGV)
 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/step_definitions/file_management_steps.rb

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

data/features/support/env.rb

@@ -1,15 +1 @@
 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/lib/reveal-ck.rb

@@ -1,25 +1,29 @@
 require_relative 'reveal-ck/version'
 require_relative 'reveal-ck/config'
+require_relative 'reveal-ck/retrieve'
+require_relative 'reveal-ck/render'
 require_relative 'reveal-ck/slide'
 require_relative 'reveal-ck/presentation'
 require_relative 'reveal-ck/presentation_dsl'
 require_relative 'reveal-ck/templates'
-require_relative 'reveal-ck/changers'
 require_relative 'reveal-ck/builders'
 require_relative 'reveal-ck/markdown'
 require_relative 'reveal-ck/tilt/config'
 
-# RevealCK::LOCATION is the path where reveal-ck is residing on your
-# system as a gem.
+# RevealCK::path_to provides the path where files within the reveal-ck
+# gem are located on your system.
 module RevealCK
-  lib = File.dirname __FILE__
-  root = File.join lib, '..'
-  LOCATION = File.expand_path root
+  def self.path_to(*args)
+    lib = File.dirname(__FILE__)
+    gem_root = File.join(lib, '..')
+    location = File.expand_path(gem_root)
+    File.join(location, *args)
+  end
 end
 
 # RevealCK::REVEALJS_FILES is a list of files that compromise
 # reveal.js bundled into this gem.
 module RevealCK
-  revealjs = File.join LOCATION, 'reveal.js'
-  REVEALJS_FILES = Dir.glob "#{revealjs}/**/*"
+  revealjs = path_to('reveal.js')
+  REVEALJS_FILES = Dir.glob("#{revealjs}/**/*")
 end

data/lib/reveal-ck/builders.rb

@@ -1,4 +1,9 @@
-require_relative 'builders/build_task'
-require_relative 'builders/builder'
+require_relative 'builders/rake_aware'
+require_relative 'builders/creation_task'
+require_relative 'builders/copy_files_task'
+require_relative 'builders/slides_builder'
+require_relative 'builders/reveal_js_files'
+require_relative 'builders/create_slides_html'
+require_relative 'builders/create_index_html'
+require_relative 'builders/user_files'
 require_relative 'builders/index_html'
-require_relative 'builders/packaged_slides'

data/lib/reveal-ck/builders/copy_files_task.rb

@@ -0,0 +1,29 @@
+module RevealCK
+  module Builders
+    # Copy a listing of files from one location to another
+    class CopyFilesTask < CreationTask
+      attr_reader :file_listing, :output_dir
+
+      def initialize(args)
+        @file_listing = retrieve(:file_listing, args)
+        @output_dir = retrieve(:output_dir, args)
+        super
+      end
+
+      def setup
+        file_listing.files.each do |file|
+          analyze_file(file) unless File.directory?(file)
+        end
+      end
+
+      def analyze_file(file)
+        dest = file.pathmap("%{^#{file_listing.dir}/,#{output_dir}/}p")
+        copy_file(file, dest)
+        dest_dir = dest.pathmap('%d')
+        create_directory(dest_dir)
+        things_to_create.add(dest_dir)
+        things_to_create.add(dest)
+      end
+    end
+  end
+end

data/lib/reveal-ck/builders/create_index_html.rb

@@ -0,0 +1,34 @@
+require 'rake'
+
+module RevealCK
+  module Builders
+    # Given a slides.html, a Rake application, a template for building
+    # out a reveal.js index.html, and a place where the resulting
+    # index.html file should end up, this class knows how to work with
+    # Rake and create the index.html.
+    class CreateIndexHtml < CreationTask
+      attr_reader :slides_html, :index_html, :output_dir, :config
+
+      def initialize(args)
+        @slides_html = retrieve(:slides_html, args)
+        @index_html = retrieve(:index_html, args)
+        @output_dir = retrieve(:output_dir, args)
+        @config = retrieve(:config, args)
+        super
+      end
+
+      def setup
+        index_html_file = "#{output_dir}/index.html"
+        task(index_html_file => slides_html) do
+          content = IndexHtml.new(slides_html: slides_html,
+                                  index_file: index_html,
+                                  config: config).render
+          File.open(index_html_file, 'w') do |index_html|
+            index_html.puts(content)
+          end
+        end
+        things_to_create.add(index_html_file)
+      end
+    end
+  end
+end

data/lib/reveal-ck/builders/create_slides_html.rb

@@ -0,0 +1,29 @@
+module RevealCK
+  module Builders
+    # Given a slides_file, a Rake application, and a place where the
+    # transformed slides file should end up, this class knows how to
+    # work with Rake and create the slides.html.
+    class CreateSlidesHtml < CreationTask
+      attr_reader :slides_file, :output_dir, :config
+
+      def initialize(args)
+        @slides_file = retrieve(:slides_file, args)
+        @output_dir = retrieve(:output_dir, args)
+        @config = retrieve(:config, args)
+        super
+      end
+
+      def setup
+        slides_html_file = "#{output_dir}/slides.html"
+        task(slides_html_file) do
+          presentation = RevealCK::Presentation.load(file: slides_file,
+                                                     config: config)
+          File.open(slides_html_file, 'w') do |slides_html|
+            slides_html.puts(presentation.html)
+          end
+        end
+        things_to_create.add(slides_html_file)
+      end
+    end
+  end
+end

data/lib/reveal-ck/builders/creation_task.rb

@@ -0,0 +1,34 @@
+module RevealCK
+  module Builders
+    # Works within the context of Rake to setup a task for a given
+    # name
+    class CreationTask
+      include Retrieve
+      include RakeAware
+      attr_reader :application, :things_to_create
+
+      def initialize(args)
+        @application = retrieve(:application, args)
+        @things_to_create = Set.new
+      end
+
+      def setup
+        fail('setup must be implemented by subclasses')
+      end
+
+      def name
+        full_class_name = self.class.to_s
+        class_name = full_class_name.gsub(/.*::/, '')
+        add_underscores = class_name.gsub(/([A-Z])/, '_\1')
+        trim_first_underscore = add_underscores[1..add_underscores.size]
+        trim_first_underscore.downcase
+      end
+
+      def prepare
+        setup
+        task(name => things_to_create.to_a)
+        name
+      end
+    end
+  end
+end