reveal-ck 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGI0YmM5MmNlMTlmNTNmODg0MjY5YjQ4N2NlYjMwNTc4MmQ4ODE2YQ==
+    MWI3OTAwYjcxYTZlODc0NTI3NWQxNzU3OGJhMzlhMTdmZmZjYmVkYQ==
   data.tar.gz: !binary |-
-    YjUwMjkzZWU5YzdmYzZmZGYxOWE3ZjRlZDQ4YTgzNTY3ZDQxNWRhZg==
+    ZDdhNDAyYWM1ODk2OWU5OTU3MWUyNDU1MjU3N2ZiYTQyOTI1M2I0Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTZjMTAyYTcyZjdlNzQxOTIxZGQ4YWYzMzk5MzZiYTUzMWUyYzUyOWE0MDQy
-    ODFjODU1NGNjMzk0ZGFjMTk5ZjI3MWZkZTE0OTkxZjQ5NzE1ZTQzNzI5NDUy
-    YWFiMTYxODlkNzAxYWY3NGM1YWRkNDlmMmVjYzZkNDRhNzBhZGQ=
+    ZGZkOGUxZTM3MTg4M2M5MWM5MTk2NDJmZmJkNThiZTVhNGEyODBkMTRmZDUw
+    ZjY1YzVkNTUwMGUyOTM5NGQzNTM4MWI1ZGNkNzVmZjYzYjVlYjM0ZDU5YTNi
+    NDUyYWU0NWQyMWJmYjhmZWNjNDA2NjYwMmY5OGVkODYxNmMyY2E=
   data.tar.gz: !binary |-
-    OTQ3OGUzNWY1ZTAwYWM1M2NmN2NiMjc4ZTAxY2U1ZDRmMDhiODhkMmIzNzM5
-    NmFkMzUzOGYyMjkyNzg3NjFiYThiYzg5MTNhZmQ0YmM0MGViYWNlMDM3ZmI5
-    NDhkMDAyMTI2ZjdjMzMxYWIxZTZiMzZhZjRjNzg0YjM4YzdkZGE=
+    M2ZkOTIwM2UxNGNkMjBlNmUyYTFiOWVmYTM1NWI2NTUyMmU3ZDIzNWVkZDA2
+    NGIyOWQ0YWRjZWNiOTM0ZGQ1ZTU0MDQxNzgwZDA0OGI5NzgyZmI1YmZkOTE3
+    MDQ2N2RmYWRjYTBkYTBjNGZkMTRmMjI5OWRjZWIwMjUzMjBlMWE=

data/README.md

@@ -151,3 +151,16 @@ features, and `rake` runs both `spec` and `cucumber`.
 
 This project is setup within Travis. Here is the
 [project page](https://travis-ci.org/jedcn/reveal-ck).
+
+### Updating the embedded reveal.js
+
+If you've got things checked out, and submodules inited, then you can
+updated the embedded reveal.js as follows:
+
+* cd into reveal.js
+* Run a `git fetch` and then merge/rebase/reset as is appropriate
+* Run tests
+* If the tests don't pass, you likely need to update how the
+  FileSplicer is invoked in the SliderBuilder. It's got hard-coded
+  begin/end line numbers for where the default reveal.js slides are
+  found. This commit is a good example of such a change: b29b050.

data/bin/reveal-ck

@@ -2,12 +2,6 @@
 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'
@@ -15,10 +9,31 @@ 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
+
+    require 'rake' # for FileList
+
+    revealjs_root = File.expand_path(File.join(File.dirname(__FILE__), '..', 'reveal.js'))
+    revealjs_files = FileList["#{revealjs_root}/**/*"]
+
+    image_files = FileList["images/**/*"]
+
+    output_dir = 'slides'
+
+    slides_haml = 'slides.haml'
+
+    config = RevealCK::Config.new config_file: 'config.toml'
+
+    builder = RevealCK::PresentationBuilder.new({
+                                                  revealjs_files: revealjs_files,
+                                                  image_files: image_files,
+                                                  output_dir: output_dir,
+                                                  slides_haml: slides_haml,
+                                                  config: config
+                                                })
+    builder.build!
+
   end
 end
 

data/lib/reveal-ck.rb

@@ -1,4 +1,10 @@
 require_relative 'reveal-ck/version'
+require_relative 'reveal-ck/config'
+require_relative 'reveal-ck/file_string_replacer'
 require_relative 'reveal-ck/file_slicer'
 require_relative 'reveal-ck/file_splicer'
 require_relative 'reveal-ck/haml_processor'
+require_relative 'reveal-ck/build_task'
+require_relative 'reveal-ck/builder'
+require_relative 'reveal-ck/slide_builder'
+require_relative 'reveal-ck/presentation_builder'

data/lib/reveal-ck/build_task.rb

@@ -0,0 +1,14 @@
+module RevealCK
+  class BuildTask
+
+    def initialize(args)
+      @description = args[:description]
+      @action = args[:action]
+    end
+
+    def go!
+      @action.call
+    end
+  end
+
+end

data/lib/reveal-ck/builder.rb

@@ -0,0 +1,21 @@
+module RevealCK
+  class Builder
+
+    def register_tasks
+      raise "Subclasses must implement register_tasks"
+    end
+
+    def add_task(description, action)
+      @tasks << BuildTask.new({
+                                description: description,
+                                action: action
+                              })
+    end
+
+    def build!
+      register_tasks unless @tasks
+      @tasks.each {|task| task.go!}
+    end
+
+  end
+end

data/lib/reveal-ck/config.rb

@@ -0,0 +1,43 @@
+require 'toml'
+
+module RevealCK
+  class Config
+
+    def initialize(args={})
+      config_file = args[:config_file]
+      @config = load_config config_file
+    end
+
+    def title
+      @config["title"]
+    end
+
+    def author
+      @config["author"]
+    end
+
+    def theme
+      @config["presentation"]["theme"]
+    end
+
+    private
+
+    DEFAULTS = {
+      "title" => "Slides",
+      "author" => "Hakim El Hattab",
+      "presentation" => {
+        "theme" => "default"
+      }
+    }
+
+    def load_config(config_file)
+      config = DEFAULTS.dup
+      if config_file && File.exists?(config_file)
+        file_config = TOML.load_file config_file
+        config.merge! file_config
+      end
+      config
+    end
+
+  end
+end

data/lib/reveal-ck/file_slicer.rb

@@ -1,23 +1,25 @@
-class FileSlicer
+module RevealCK
+  class FileSlicer
 
-  def self.remove!(path, range)
-    slice_file = if File.exists? path
-      path
-    else
-      File.expand_path(File.join(Dir.pwd, path))
+    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
-    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 initialize(lines)
+      @lines = lines
+    end
 
-  def remove(range)
-    @lines.select.with_index { |line, index| ! range.cover? index }
-  end
+    def remove(range)
+      @lines.select.with_index { |line, index| ! range.cover? index }
+    end
 
+  end
 end

data/lib/reveal-ck/file_splicer.rb

@@ -1,39 +1,41 @@
-class FileSplicer
+module RevealCK
+  class FileSplicer
 
-  def initialize(lines)
-    @lines = lines
-  end
+    def initialize(lines)
+      @lines = lines
+    end
 
-  def insert(new_lines, opts)
-    index = @lines.each.with_index do |line, i|
-      break i + 1 if line.include? opts[:after]
+    def insert(new_lines, opts)
+      index = @lines.each.with_index do |line, i|
+        break i + 1 if line.include? opts[:after]
+      end
+      @lines.insert(index, new_lines).flatten
     end
-    @lines.insert(index, new_lines).flatten
-  end
 
-  def self.insert!(to_insert, opts)
-    to_insert_lines = readlines to_insert
-    insert_into_file = find_file opts[:into]
-    insert_into_lines = readlines insert_into_file
+    def self.insert!(to_insert, opts)
+      to_insert_lines = readlines to_insert
+      insert_into_file = find_file opts[:into]
+      insert_into_lines = readlines insert_into_file
 
-    splicer = FileSplicer.new insert_into_lines
-    spliced_lines = splicer.insert to_insert_lines, after: opts[:after]
-    File.open(insert_into_file, 'w') { |f| f << spliced_lines.join }
-  end
+      splicer = FileSplicer.new insert_into_lines
+      spliced_lines = splicer.insert to_insert_lines, after: opts[:after]
+      File.open(insert_into_file, 'w') { |f| f << spliced_lines.join }
+    end
 
-  private
+    private
 
-  def self.find_file(path)
-    if File.exists? path
-      path
-    else
-      File.expand_original(File.join(Dir.pwd, to_insert))
+    def self.find_file(path)
+      if File.exists? path
+        path
+      else
+        File.expand_original(File.join(Dir.pwd, to_insert))
+      end
     end
-  end
 
-  def self.readlines(path)
-    file = find_file path
-    File.open(file).readlines
-  end
+    def self.readlines(path)
+      file = find_file path
+      File.open(file).readlines
+    end
 
+  end
 end

data/lib/reveal-ck/file_string_replacer.rb

@@ -0,0 +1,17 @@
+module RevealCK
+  class FileStringReplacer
+
+    def self.replace!(path, args)
+      old, new = args[:old], args[:new]
+      file = if File.exists? path
+               path
+             else
+               File.expand_path(File.join(Dir.pwd, path))
+             end
+      lines = File.open(file).read
+      lines = lines.sub old, new
+      File.open(file, 'w') { |f| f << lines }
+    end
+
+  end
+end

data/lib/reveal-ck/haml_processor.rb

@@ -1,24 +1,26 @@
 require 'haml'
 require 'ostruct'
 
-class HamlProcessor
+module RevealCK
+  class HamlProcessor
 
-  attr_reader :html
+    attr_reader :html
 
-  def initialize(haml)
-    render_context = ::OpenStruct.new({})
-    engine = ::Haml::Engine.new haml
-    @html = engine.render render_context
-  end
+    def initialize(haml)
+      render_context = ::OpenStruct.new({})
+      engine = ::Haml::Engine.new haml
+      @html = engine.render render_context
+    end
 
-  def self.open(path)
-    haml_file = if File.exists? path
-      path
-    else
-      File.expand_path(File.join(Dir.pwd, path))
+    def self.open(path)
+      haml_file = if File.exists? path
+                    path
+                  else
+                    File.expand_path(File.join(Dir.pwd, path))
+                  end
+      haml = File.open(haml_file).read
+      HamlProcessor.new haml
     end
-    haml = File.open(haml_file).read
-    HamlProcessor.new haml
-  end
 
+  end
 end

data/lib/reveal-ck/presentation_builder.rb

@@ -0,0 +1,69 @@
+require 'fileutils'
+
+module RevealCK
+  #
+  # Public: A PresentationBuilder knows how to bundle together all of
+  # the various files that makeup a reveal.js presentation
+  #
+  class PresentationBuilder < Builder
+
+    attr_reader :revealjs_files, :image_files, :slides_haml, :config
+    attr_reader :tasks
+
+    def initialize(args)
+      @revealjs_files, @image_files = args[:revealjs_files], args[:image_files]
+      @slides_haml = args[:slides_haml]
+      @output_dir = args[:output_dir]
+      @config = args[:config]
+    end
+
+    def output_dir(child=nil)
+      if child
+        File.join(@output_dir, child)
+      else
+        @output_dir
+      end
+    end
+
+    private
+
+    def register_tasks
+
+      @tasks = []
+
+      add_task "Ensuring #{output_dir}/ exists",
+               lambda {
+                 FileUtils.mkdir_p output_dir, verbose: false
+               }
+
+      add_task "Transforming #{slides_haml} into #{output_dir('slides_html')}'}",
+               lambda {
+                 processor = HamlProcessor.open slides_haml
+                 File.open(output_dir('slides.html'), 'w') { |f| f << processor.html }
+               }
+
+      add_task "Bundling up the revealjs stuff into #{output_dir}/",
+               lambda {
+                 FileUtils.cp_r revealjs_files, output_dir, verbose: false
+               }
+
+      add_task "Copying in images into #{output_dir('images')}",
+               lambda {
+                 FileUtils.mkdir_p output_dir('images'), verbose: false
+                 FileUtils.cp_r image_files, output_dir('images'), verbose: false
+               }
+
+      add_task "Creating slides/index.html",
+               lambda {
+                 slide_builder = SlideBuilder.new({
+                                                    user_slides: output_dir('slides.html'),
+                                                    reveal_slides: output_dir('index.html'),
+                                                    config: config
+                                                  })
+                 slide_builder.build!
+               }
+
+    end
+
+  end
+end

data/lib/reveal-ck/slide_builder.rb

@@ -0,0 +1,66 @@
+module RevealCK
+  #
+  # Public: A SlideBuilder knows how to build the index.html file (the
+  # core slides) within a reveal.js presentation.
+  #
+  class SlideBuilder < Builder
+
+    attr_reader :user_slides, :reveal_slides
+
+    attr_reader :tasks
+
+    attr_reader :config
+
+    def initialize(args)
+      @user_slides = args[:user_slides]
+      @reveal_slides = args[:reveal_slides]
+      @config = args[:config]
+    end
+
+    private
+
+    def register_tasks
+
+      @tasks = []
+
+      add_task "Slicing out reveal.js default slides",
+               lambda {
+                 line_nums = {
+                   default_slides: {
+                     first: 38, # Line where I see <div class="slides">
+                     last: 346  # Closing <div>
+                   }
+                 }
+                 default_slides = line_nums[:default_slides][:first]..line_nums[:default_slides][:last]
+                 FileSlicer.remove! reveal_slides, default_slides
+               }
+
+      add_task "Splicing in slides from #{user_slides}",
+               lambda {
+                 FileSplicer.insert! user_slides, into: reveal_slides, after: '<div class="slides">'
+               }
+
+      old_title = 'reveal.js - The HTML Presentation Framework'
+      new_title = config.title
+      add_task "Replacing the <title>",
+               lambda {
+                 FileStringReplacer.replace! reveal_slides, old: old_title, new: config.title
+               }
+
+      old_author = 'name="author" content="Hakim El Hattab"'
+      new_author = 'name="author" content="' + config.author + '"'
+      add_task "Replacing the <meta name='author'>",
+               lambda {
+                 FileStringReplacer.replace! reveal_slides, old: old_author, new: new_author
+               }
+
+      old_theme = 'href="css/theme/default.css" id="theme"'
+      new_theme = 'href="css/theme/' + config.theme + '.css" id="theme"'
+      add_task 'Replacing the core theme',
+               lambda {
+                 FileStringReplacer.replace! reveal_slides, old: old_theme, new: new_theme
+               }
+    end
+
+  end
+end