reveal-ck 0.1.5 → 0.1.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Mjg0NzYyNTNiNjY1NjZjZjE0MzBiYjQ2YjJlOGQ1YWE2ODRkYjNlMg==
+    NjdkMTYxMjE5OGFhMDQ5ZmNiMzdhYWQwZGYwOGM3NTQ4NmNhYmYzOA==
   data.tar.gz: !binary |-
-    YzE0MDdlYzUwMjk3NmY1MzViOTI2NzJkZTY0N2Q1NmIwYTczZjNjOA==
+    NTU5OTMwZGI1NTc5OTJjNDc1MDk4YTFlNjY4NjA1ZWJhZGRkZjI2YQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDZjNGNkNTAxOGZmOGIzNjFjOWI2ZGEzYjE2YjcyZTMxNDQzMGQwNGNjNGM4
-    ZDM1ZDM3MGYzYTgwZGY0NjhhZjFhYzY2YzEwZDkyMTQ4NThmODgwMDQxNzI4
-    ZTY1ZmVmODYzOTQwZTc5OTFiMTVhMDEyOTZlZTdlMDM3YmE0YWU=
+    M2E1N2FlMzVhM2JmMWU0M2YzYmMwYzIwNGZjMzYxY2U3NGY0MWQzYWM0NmVh
+    M2RiOTE0NTRiYjJiMzRmYWUwOWE1Y2IyMDI1ZmE4ZDQyODA4OTQzZjRhOTg3
+    ZmEzNmU5OTJiYTFhZjRiNTNjMDA3ZjViZjg2YmQzZGU2NTJjYmE=
   data.tar.gz: !binary |-
-    NzYyY2MyYWQyNjcwYzFlMGIxMWY3NDYxOGU4MDQ3NjMyZDk4MWRkNjI4Yjg4
-    NmEzZDVjNTMzMzU5MTY4NzBmMTMxZjJjMWU0ODJiY2MyMTcyNzgwZTg1YzI0
-    NGU1NDgwMzE5MTQzZGZlZmM2ZjBjN2Q2YTNlYjEwM2I4ZWQ4MGU=
+    ZTNiOTVhZDNhOGE5ZWExYmUzM2Y2MTM5Njk2YjhiZWM5OTVkZjYyZDNkOWJl
+    MmE0OGQ4NjFhOWQwNDg2NzBjOTZjOTA5YWRiZDk5NGUyYjcwMmQ3MTdiM2Zm
+    YmY5MjUwMTJlOTY0NzVmOGIwNjlkZTMwZjQ0ODI2ZWJmM2I1NTE=

data/README.md

@@ -1,6 +1,7 @@
 # reveal-ck: a [reveal.js][reveal-js] construction kit
 
 [![Build Status][travis-reveal-ck-badge]](https://travis-ci.org/jedcn/reveal-ck)
+[![Code Climate][code-climate-reveal-ck-badge]](https://codeclimate.com/github/jedcn/reveal-ck)
 
 ## Overview
 
@@ -36,9 +37,9 @@ 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.slim` or
-`slides.haml`). It only contains the slide content I am presenting and
-there's minimal markup.
+the list of slides to a single file (`slides.slim`, `slides.haml`, or
+`slides.rb`). This file only contains the slide content that I am
+presenting and there is minimal markup.
 
 * 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 a
@@ -55,42 +56,25 @@ there's minimal markup.
 In the end, [reveal.js][reveal-js], can make things pretty, but only
 you can make a presentation that is worthwhile.
 
-## One Last Thought: Slides in Ruby
+## Getting Started
 
-Slim and Haml are decent, but the approach outlined so far means that
-a user of reveal-ck needs to understand markup and conventions within
-reveal.js. A templating language makes things less verbose, but it's
-still a templating language.
+You can author a set of slides by writing in a templating language,
+such as [Slim][slim] or [Haml][haml], or you can build them
+programmatically in ruby. Check out the
+[getting started][reveal-ck-getting-started] instructions, and let me
+know if you have any trouble.
 
-If you'd like to go one step further, reveal-ck gives you the
-opportunity to author slides in ruby. It comes with a small number of
-pre-built templates that encapsulate reveal.js tag names, attributes,
-and classes aside and provides classes that enable you to create
-slides programmatically. See `examples/programmatic-slides.rb` for an
-example.
+## Development
 
-What's more, once we've got programmatic support, it's not too much
-harder to build a DSL. So, now you can create a file named `slides.rb`
-(which replaces `slides.slim` or `slides.haml`) and write something
-like this:
+If you are interested in hacking on reveal-ck, check out the
+[development page][reveal-ck-development].
 
-```ruby
-slide 'title',
-      title: 'Here we go!',
-      author: 'Jed Northridge'
-
-slide 'quote',
-      content: "when you don't create things, you become defined by your tastes rather than ability. your tastes only narrow & exclude people. so create."
-
-['3', '2', '1', 'Contact!'].each do |s|
-  slide 'text', content: s
-end
-```
-
-You can now run `reveal-ck generate` with `slides.rb` and build slides
-in ruby.
-
-[jedcn-reveal-ck]: http://jedcn.com/posts/reveal-ck
+[code-climate-reveal-ck-badge]: https://codeclimate.com/github/jedcn/reveal-ck.png
 [github-jedcn-reveal-ck-template]: http://github.com/jedcn/reveal-ck-template
+[haml]: http://haml.info/
+[jedcn-reveal-ck]: http://jedcn.com/posts/reveal-ck
+[reveal-ck-development]: https://github.com/jedcn/reveal-ck/blob/master/doc/development.md
+[reveal-ck-getting-started]: https://github.com/jedcn/reveal-ck/blob/master/doc/getting_started.md
 [reveal-js]: http://lab.hakim.se/reveal-js
+[slim]: http://slim-lang.com/
 [travis-reveal-ck-badge]: https://travis-ci.org/jedcn/reveal-ck.png

data/Rakefile

@@ -14,4 +14,4 @@ end
 
 require 'rake'
 require 'rake/clean'
-task :default => [ :spec, :cucumber ]
+task :default => [ :spec, :cucumber, :quality ]

data/lib/reveal-ck.rb

@@ -12,8 +12,19 @@ require_relative 'reveal-ck/builder'
 require_relative 'reveal-ck/slides_html_builder'
 require_relative 'reveal-ck/slide_builder'
 require_relative 'reveal-ck/presentation_builder'
+require_relative 'reveal-ck/presentation_dsl'
 
+# RevealCK::LOCATION is the path where reveal-ck is residing on your
+# system as a gem.
 module RevealCK
-  revealjs_root = File.expand_path(File.join(File.dirname(__FILE__), '..', 'reveal.js'))
-  REVEALJS_FILES = Dir.glob "#{revealjs_root}/**/*"
+  lib = File.dirname __FILE__
+  root = File.join lib, '..'
+  LOCATION = File.expand_path root
+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}/**/*"
 end

data/lib/reveal-ck/build_task.rb

@@ -1,12 +1,17 @@
 module RevealCK
+  #
+  # Public: A BuildTask couple a written description (in the form of a
+  # string) with an action in (the form of a proc). It executes the
+  # proc on demand via go!
+  #
   class BuildTask
 
-    def initialize(args)
-      @description = args[:description]
-      @action = args[:action]
+    def initialize(description, action)
+      @description = description
+      @action = action
     end
 
-    def go!
+    def go
       @action.call
     end
   end

data/lib/reveal-ck/builder.rb

@@ -1,20 +1,24 @@
 module RevealCK
+  #
+  # Public: A Builder knows how to execute BuildTasks. These are added
+  # via add_task, and executed via build!
+  #
+  # It is expected to be subclassed, and the subclass must override
+  # register_tasks.
+  #
   class Builder
 
     def register_tasks
-      raise "Subclasses must implement register_tasks"
+      raise 'Subclasses must implement register_tasks'
     end
 
-    def add_task(description, action)
-      @tasks << BuildTask.new({
-                                description: description,
-                                action: action
-                              })
+    def add_task(description, &action)
+      @tasks << BuildTask.new(description, action)
     end
 
     def build!
       register_tasks unless @tasks
-      @tasks.each {|task| task.go!}
+      @tasks.each { |task| task.go }
     end
 
   end

data/lib/reveal-ck/config.rb

@@ -1,32 +1,37 @@
 require 'toml'
 
 module RevealCK
+  #
+  # Public: A Config knows about the core configuration values of a
+  # RevealCK Presentation: title, author, theme, etc. It knows about
+  # sensible defaults, and it can read these from a toml file.
+  #
   class Config
 
-    def initialize(args={})
+    def initialize(args = {})
       config_file = args[:config_file]
       @config = load_config config_file
     end
 
     def title
-      @config["title"]
+      @config['title']
     end
 
     def author
-      @config["author"]
+      @config['author']
     end
 
     def theme
-      @config["presentation"]["theme"]
+      @config['presentation']['theme']
     end
 
     private
 
     DEFAULTS = {
-      "title" => "Slides",
-      "author" => "Hakim El Hattab",
-      "presentation" => {
-        "theme" => "default"
+      'title' => 'Slides',
+      'author' => 'Hakim El Hattab',
+      'presentation' => {
+        'theme' => 'default'
       }
     }
 

data/lib/reveal-ck/file_slicer.rb

@@ -1,16 +1,14 @@
 module RevealCK
+  #
+  # Public: A FileSlicer knows how to remove a section of a file.
+  #
   class FileSlicer
 
-    def self.remove!(path, range)
-      slice_file = if File.exists? path
-                     path
-                   else
-                     File.expand_path(File.join(Dir.pwd, path))
-                   end
+    def self.remove!(slice_file, range)
       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 }
+      File.open(slice_file, 'w') { |file| file << sliced_lines.join }
     end
 
     def initialize(lines)

data/lib/reveal-ck/file_splicer.rb

@@ -1,4 +1,8 @@
 module RevealCK
+  #
+  # Public: A FileSplicer knows how to insert a list of lines into a
+  # file.
+  #
   class FileSplicer
 
     def initialize(lines)
@@ -14,26 +18,17 @@ module RevealCK
 
     def self.insert!(to_insert, opts)
       to_insert_lines = readlines to_insert
-      insert_into_file = find_file opts[:into]
+      insert_into_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 }
+      File.open(insert_into_file, 'w') { |file| file << spliced_lines.join }
     end
 
     private
 
-    def self.find_file(path)
-      if File.exists? path
-        path
-      else
-        File.expand_original(File.join(Dir.pwd, to_insert))
-      end
-    end
-
-    def self.readlines(path)
-      file = find_file path
+    def self.readlines(file)
       File.open(file).readlines
     end
 

data/lib/reveal-ck/file_string_replacer.rb

@@ -1,16 +1,15 @@
 module RevealCK
+  #
+  # Public: A FileStringReplacer knows how to replace one string
+  # in a file with another.
+  #
   class FileStringReplacer
 
-    def self.replace!(path, args)
+    def self.replace!(file, 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 }
+      File.open(file, 'w') { |file| file << lines }
     end
 
   end

data/lib/reveal-ck/presentation.rb

@@ -1,4 +1,10 @@
 module RevealCK
+  #
+  # Public: A Presentation is an ordered list of slides. It provides
+  # access to the content of the slides on demand. It it also the
+  # mechanism by which the slide "dsl" is defined and loaded into
+  # being.
+  #
   class Presentation
 
     attr_accessor :theme, :title, :author
@@ -13,34 +19,12 @@ module RevealCK
     end
 
     def content
-      s = ""
+      content = ''
       @slides.each do |slide|
-        s << slide.html
-        s << "\n\n"
+        content << slide.html
+        content << "\n\n"
       end
-      s
-    end
-
-  end
-end
-
-module RevealCK
-  class Presentation
-
-    def self.load(file)
-      presentation = Presentation.new
-      content = File.open(file).read
-      presentation.eval content
-      presentation
-    end
-
-    def eval(s)
-      instance_eval s
-    end
-
-    def slide(template, variables)
-      variables[:template] = template
-      add_slide(Slide.new(variables))
+      content
     end
 
   end

data/lib/reveal-ck/presentation_builder.rb

@@ -14,12 +14,13 @@ module RevealCK
       @image_files = args[:image_files]
       @slides_file = args[:slides_file]
       @presentation = args[:presentation]
-      raise 'either :slides_file or :presentation is required' unless @slides_file || @presentation
+      missing_info = 'either :slides_file or :presentation is required'
+      raise missing_info unless @slides_file || @presentation
       @output_dir = args[:output_dir]
       @config = args[:config]
     end
 
-    def output_dir(child=nil)
+    def output_dir(child = nil)
       if child
         File.join(@output_dir, child)
       else
@@ -30,52 +31,64 @@ module RevealCK
     private
 
     def register_tasks
-
       @tasks = []
+      slides_html = output_dir 'slides.html'
+      create_dir output_dir
+      transform_slides @slides_file, @presentation, slides_html
+      bundle_revealjs output_dir
+      bundle_image_files image_files, output_dir('images')
+      config = @presentation || @config
+      create_index_html slides_html, output_dir('index.html'), config
+    end
 
-      add_task "Ensuring #{output_dir}/ exists",
-               lambda {
-                 FileUtils.mkdir_p output_dir, verbose: false
-               }
+    def create_dir(dir)
+      add_task "Ensuring #{dir}/ exists" do
+        FileUtils.mkdir_p dir, verbose: false
+      end
+    end
 
-      if @slides_file
-        add_task "Transforming #{slides_file} into #{output_dir('slides.html')}'}",
-                 lambda {
-                   builder = SlidesHtmlBuilder.new input_file: @slides_file
-                   builder.write_to file: output_dir('slides.html')
-                 }
+    def transform_slides(slides_file, presentation, slides_html)
+      if slides_file
+        description = "Transforming #{slides_file} into '#{slides_html}'}"
+        builder = SlidesHtmlBuilder.new input_file: slides_file
       else
-        add_task "Transforming Presentation into #{output_dir('slides.html')}'}",
-                 lambda {
-                   builder = SlidesHtmlBuilder.new presentation: @presentation
-                   builder.write_to file: output_dir('slides.html')
-                 }
+        description = "Transforming Presentation into '#{slides_html}'}"
+        builder = SlidesHtmlBuilder.new presentation: presentation
+      end
+      add_task description do
+        builder.write_to file: slides_html
       end
+    end
 
-      add_task "Bundling up the revealjs stuff into #{output_dir}/",
-               lambda {
-                 FileUtils.cp_r RevealCK::REVEALJS_FILES, output_dir, verbose: false
-               }
+    def bundle_revealjs(output_dir)
+      add_task "Bundling up the revealjs stuff into #{output_dir}/" do
+        FileUtils.cp_r(RevealCK::REVEALJS_FILES,
+                       output_dir,
+                       verbose: false)
+      end
+    end
 
+    def bundle_image_files(image_files, image_output_dir)
       if image_files
-        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 "Copying in images into '#{image_output_dir}'" do
+          FileUtils.mkdir_p(image_output_dir, verbose: false)
+          FileUtils.cp_r(image_files,
+                         image_output_dir,
+                         verbose: false)
+        end
       end
-
-      add_task "Creating slides/index.html",
-               lambda {
-                 slide_builder = SlideBuilder.new({
-                                                    user_slides: output_dir('slides.html'),
-                                                    reveal_slides: output_dir('index.html'),
-                                                    config: @presentation || config
-                                                  })
-                 slide_builder.build!
-               }
-
     end
 
+    def create_index_html(slides_html, index_html, config)
+      add_task 'Creating slides/index.html' do
+        slide_builder =
+          SlideBuilder.new({
+                             user_slides: slides_html,
+                             reveal_slides: index_html,
+                             config: config
+                           })
+        slide_builder.build!
+      end
+    end
   end
 end

data/lib/reveal-ck/presentation_dsl.rb

@@ -0,0 +1,54 @@
+module RevealCK
+  #
+  # Public: A PresentationDSL defines the DSL behind a
+  # presentation. It also knows how to load file containing the DSL.
+  #
+  class PresentationDSL
+
+    def initialize
+      @slides = []
+    end
+
+    def theme(theme = 'default')
+      @theme = theme
+    end
+
+    def title(title = 'Slides')
+      @title = title
+    end
+
+    def author(author = '')
+      @author = author
+    end
+
+    def slide(template, variables)
+      variables[:template] = template
+      @slides << RevealCK::Slide.new(variables)
+    end
+
+    def build
+      presentation = RevealCK::Presentation.new
+      presentation.theme = @theme
+      presentation.author = @author
+      presentation.title = @title
+      @slides.each do |slide|
+        presentation.add_slide slide
+      end
+      presentation
+    end
+
+    require 'docile'
+
+    def presentation(&block)
+      Docile.dsl_eval(PresentationDSL.new, &block).build
+    end
+
+    def self.load(file)
+      builder = PresentationDSL.new
+      contents = File.open(file).read
+      result = builder.instance_eval contents
+      result
+    end
+
+  end
+end

data/lib/reveal-ck/slide_builder.rb

@@ -23,43 +23,58 @@ module RevealCK
 
       @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
-               }
+      remove_default_content reveal_slides
+      add_user_content reveal_slides, user_slides
+      replace_title reveal_slides, config.title
+      replace_author reveal_slides, config.author
+      replace_theme reveal_slides, config.theme
+    end
+
+    def remove_default_content(file)
+      add_task 'Slicing out reveal.js default slides' do
+        begin_line_num = 38 # Line where I see <div class="slides">
+        end_line_num = 346 # Closing <div>
+        default_slides = begin_line_num..end_line_num
+        FileSlicer.remove! file, default_slides
+      end
+    end
 
-      add_task "Splicing in slides from #{user_slides}",
-               lambda {
-                 FileSplicer.insert! user_slides, into: reveal_slides, after: '<div class="slides">'
-               }
+    def add_user_content(file, user_slides)
+      add_task "Splicing in slides from #{user_slides}" do
+        FileSplicer.insert!(user_slides,
+                            into: file,
+                            after: '<div class="slides">')
+      end
+    end
 
+    def replace_title(file, title)
       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
-               }
+      new_title = title
+      add_task 'Replacing the <title>' do
+        FileStringReplacer.replace!(file,
+                                    old: old_title,
+                                    new: new_title)
+      end
+    end
 
+    def replace_author(file, author)
       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
-               }
+      new_author = 'name="author" content="' + author + '"'
+      add_task "Replacing the <meta name='author'>" do
+        FileStringReplacer.replace!(file,
+                                    old: old_author,
+                                    new: new_author)
+      end
+    end
 
+    def replace_theme(file, theme)
       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
-               }
+      new_theme = 'href="css/theme/' + theme + '.css" id="theme"'
+      add_task 'Replacing the core theme' do
+        FileStringReplacer.replace!(file,
+                                    old: old_theme,
+                                    new: new_theme)
+      end
     end
 
   end

data/lib/reveal-ck/slides_html_builder.rb

@@ -1,16 +1,25 @@
 module RevealCK
+  #
+  # Public: A SlidesHtmlBuilder knows how to create the intermediate
+  # file slides.html. This file is a users generate slide content, and
+  # is ultimately inserted within reveal.js.
+  #
+  # A slides.html can be created from a template or from an instance
+  # of a Presentation.
+  #
   class SlidesHtmlBuilder
 
     def initialize(args)
       @input_file = args[:input_file]
       @presentation = args[:presentation]
-      raise 'either :input_file or :presentation are required' unless @input_file || @presentation
+      missing_info = 'either :input_file or :presentation are required'
+      raise missing_info unless @input_file || @presentation
     end
 
     def render
       if @input_file
         if @input_file.end_with? '.rb'
-          presentation = RevealCK::Presentation.load @input_file
+          presentation = RevealCK::PresentationDSL.load @input_file
           presentation.content
         else
           template = TemplateProcessor.open @input_file
@@ -23,7 +32,7 @@ module RevealCK
 
     def write_to(args)
       file = args[:file] || raise(':file is required')
-      File.open(file, 'w') { |f| f << render }
+      File.open(file, 'w') { |file| file << render }
     end
 
   end

data/lib/reveal-ck/template_finder.rb

@@ -9,16 +9,14 @@ module RevealCK
 
     attr_reader :paths
 
-    def initialize(args={})
+    def initialize(args = {})
       @paths = args[:paths] || default_paths
     end
 
     def default_paths
       pwd = Dir.pwd
-      pwd_templates = File.join Dir.pwd, 'templates'
-      reveal_ck_templates =
-        File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'templates'))
-
+      pwd_templates = pwd, 'templates'
+      reveal_ck_templates = File.join RevealCK::LOCATION, 'templates'
       [pwd, pwd_templates, reveal_ck_templates]
     end
 

data/lib/reveal-ck/template_processor.rb

@@ -4,6 +4,10 @@ require 'slim'
 ::Slim::Engine.set_default_options pretty: true
 
 module RevealCK
+  #
+  # Public: A TemplateProcessor is given a template and expected to
+  # render it.
+  #
   class TemplateProcessor
 
     require 'tilt'
@@ -12,16 +16,11 @@ module RevealCK
       @template = Tilt.new file
     end
 
-    def output(scope=nil, locals = {})
+    def output(scope = nil, locals = {})
       @template.render scope, locals
     end
 
-    def self.open(path)
-      file = if File.exists? path
-               path
-             else
-               File.expand_path(File.join(Dir.pwd, path))
-             end
+    def self.open(file)
       TemplateProcessor.new file
     end
 

data/lib/reveal-ck/version.rb

@@ -1,3 +1,3 @@
 module RevealCK
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/rakelib/cane.rake

@@ -0,0 +1,10 @@
+begin
+  require 'cane/rake_task'
+
+  desc 'Run cane to check quality metrics'
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.canefile = '.cane'
+  end
+rescue LoadError
+  warn "cane not available, quality task not provided."
+end

data/rakelib/simplecov.rake

@@ -0,0 +1 @@
+CLEAN << 'coverage'

data/spec/data/dsl/slides.rb

@@ -0,0 +1,13 @@
+presentation do
+
+  title  'Presentation Title'
+  author 'Presentation Author'
+  theme  'night'
+
+  slide 'text',
+    content: 'Hello World'
+
+  slide 'text',
+    content: 'Thanks!'
+
+end

data/spec/data/slides_html_builder/slides.rb

@@ -1,4 +1,14 @@
-slide 'quote',
-      headline: 'Hello Ruby!',
-      quote:    "No.  It's kinda complex.  Ruby is simple in appearance, but is very complex inside, just like our human body.",
-      citation: 'http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/2773'
+presentation do
+
+  matz_says = %{
+No.  It's kinda complex.  Ruby is simple in appearance, but is very
+complex inside, just like our human body.
+}
+
+  citation = 'http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/2773'
+
+  slide 'quote',
+          headline: 'Hello Ruby!',
+          quote:    matz_says,
+          citation: citation
+end

data/spec/lib/reveal-ck/builder_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module RevealCK
+
+  describe Builder, 'when subclassed' do
+
+    it 'requires that subclasses implement #register_tasks' do
+      class BadBuilder < Builder; end
+      bad_builder = BadBuilder.new
+      expect { bad_builder.register_tasks }.to raise_error
+    end
+
+    it 'invokes each registered task when it receives #build' do
+
+      class TestBuilder < Builder
+
+        attr_reader :value
+
+        def initialize
+          @value = 0
+        end
+
+        def register_tasks
+          @tasks = []
+          @value = 0
+          add_task 'Set Value to 1' do
+            @value = 1
+          end
+        end
+      end
+
+      test_builder = TestBuilder.new
+      test_builder.build!
+      expect(test_builder.value).to eq 1
+    end
+  end
+end

data/spec/lib/reveal-ck/file_string_replacer_spec.rb

@@ -20,7 +20,9 @@ module RevealCK
         Dir.mktmpdir do |tmp_dir|
           FileUtils.cp before_replace, tmp_dir
           test_file = File.join tmp_dir, 'before_replace'
-          FileStringReplacer.replace! test_file, old: ' hideaway at sea', new: 'hh coconuts!'
+          FileStringReplacer.replace!(test_file,
+                                      old: ' hideaway at sea',
+                                      new: 'hh coconuts!')
           test_file_contents = File.open(test_file).read
           after_replace_contents = File.open(after_replace).read
           test_file_contents.should == after_replace_contents

data/spec/lib/reveal-ck/presentation_builder_spec.rb

@@ -23,10 +23,11 @@ module RevealCK
 
       tmp_dir = Dir.mktmpdir
 
-      presentation_builder = PresentationBuilder.new({
-                                                       presentation: presentation,
-                                                       output_dir: tmp_dir,
-                                                     })
+      presentation_builder =
+        PresentationBuilder.new({
+                                  presentation: presentation,
+                                  output_dir: tmp_dir,
+                                })
       presentation_builder.build!
 
       expect(File.exists? File.join(tmp_dir, "index.html")).to be_true

data/spec/lib/reveal-ck/presentation_dsl_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module RevealCK
+  describe PresentationDSL do
+
+    let :dsl_file do
+      File.join 'spec', 'data', 'dsl', 'slides.rb'
+    end
+
+    let :presentation do
+      PresentationDSL.load dsl_file
+    end
+
+    describe '#load' do
+      it 'can build a RevealCK::Presentation from a file' do
+        result = PresentationDSL.load dsl_file
+        expect(result).to be_a Presentation
+      end
+    end
+
+    describe '.author' do
+      it 'defines the author in the Presentation' do
+        expect(presentation.author).to eq 'Presentation Author'
+      end
+    end
+
+    describe '.theme' do
+      it 'defines the theme in the Presentation' do
+        expect(presentation.theme).to eq 'night'
+      end
+    end
+
+    describe '.title' do
+      it 'defines the title in the Presentation' do
+        expect(presentation.title).to eq 'Presentation Title'
+      end
+    end
+
+  end
+end

data/spec/lib/reveal-ck/presentation_spec.rb

@@ -57,22 +57,5 @@ module RevealCK
       expect(presentation.author).to eq 'Hakim El Hattab'
     end
 
-    describe '#slide' do
-      it 'is a shortcut for creating a new Slide and calling #add_slide' do
-        presentation = Presentation.new
-
-        expect(Slide)
-          .to(receive(:new)
-                .with({ template: 'text', content: 'spec' })
-                .and_call_original)
-
-        expect(presentation)
-          .to(receive(:add_slide)
-                .with(kind_of(Slide)))
-
-        presentation.eval "slide('text', { content: 'spec' })"
-      end
-    end
-
   end
 end

data/spec/lib/reveal-ck/template_finder_spec.rb

@@ -22,7 +22,8 @@ module RevealCK
 
       it 'can be assigned via initializer' do
         Dir.mktmpdir do |dir|
-          finder = TemplateFinder.new paths: [ dir, File.join(dir, 'templates') ]
+          paths = [ dir, File.join(dir, 'templates') ]
+          finder = TemplateFinder.new paths: paths
           expect(finder.paths).to include dir
           expect(finder.paths).to include File.join(dir, 'templates')
           expect(finder.paths.size).to eq 2
@@ -56,11 +57,16 @@ module RevealCK
 
       it 'searches all paths to find templates' do
         result = finder.find 'automated'
-        expect(result).to include File.join('template_finder', 'automated', 'automated.slim')
+        automated_slim = File.join('automated', 'automated.slim')
+        expect(result).to include automated_slim
+
         result = finder.find 'custom'
-        expect(result).to include File.join('template_finder', 'custom', 'custom.slim')
+        custom_slim = File.join('custom', 'custom.slim')
+        expect(result).to include custom_slim
+
         result = finder.find 'title'
-        expect(result).to include File.join('reveal-ck', 'templates', 'title.slim')
+        title_slim = File.join('reveal-ck', 'templates', 'title.slim')
+        expect(result).to include title_slim
       end
 
       it 'searchs paths in order and returns the first match' do
@@ -73,6 +79,9 @@ module RevealCK
         expect(result).to include File.join('custom', 'common.haml')
       end
 
+      it 'raises if it cannot find what you asked for' do
+        expect { finder.find 'unknown' }.to raise_error
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reveal-ck
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Jed Northridge
@@ -108,6 +108,48 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -245,14 +287,17 @@ files:
 - lib/reveal-ck/file_string_replacer.rb
 - lib/reveal-ck/presentation.rb
 - lib/reveal-ck/presentation_builder.rb
+- lib/reveal-ck/presentation_dsl.rb
 - lib/reveal-ck/slide.rb
 - lib/reveal-ck/slide_builder.rb
 - lib/reveal-ck/slides_html_builder.rb
 - lib/reveal-ck/template_finder.rb
 - lib/reveal-ck/template_processor.rb
 - lib/reveal-ck/version.rb
+- rakelib/cane.rake
 - rakelib/cucumber.rake
 - rakelib/rspec.rake
+- rakelib/simplecov.rake
 - templates/code.slim
 - templates/image.slim
 - templates/quote.slim
@@ -264,6 +309,7 @@ files:
 - features/support/env.rb
 - features/support/file_management.rb
 - spec/data/config/config.toml
+- spec/data/dsl/slides.rb
 - spec/data/haml/basic.haml
 - spec/data/html/converted_basic_haml.html
 - spec/data/html/converted_basic_slim.html
@@ -283,11 +329,13 @@ files:
 - spec/data/template_finder/automated/common.haml
 - spec/data/template_finder/custom/common.haml
 - spec/data/template_finder/custom/custom.slim
+- spec/lib/reveal-ck/builder_spec.rb
 - spec/lib/reveal-ck/config_spec.rb
 - spec/lib/reveal-ck/file_slicer_spec.rb
 - spec/lib/reveal-ck/file_splicer_spec.rb
 - spec/lib/reveal-ck/file_string_replacer_spec.rb
 - spec/lib/reveal-ck/presentation_builder_spec.rb
+- spec/lib/reveal-ck/presentation_dsl_spec.rb
 - spec/lib/reveal-ck/presentation_spec.rb
 - spec/lib/reveal-ck/slide_spec.rb
 - spec/lib/reveal-ck/slides_html_builder_spec.rb
@@ -326,6 +374,7 @@ test_files:
 - features/support/env.rb
 - features/support/file_management.rb
 - spec/data/config/config.toml
+- spec/data/dsl/slides.rb
 - spec/data/haml/basic.haml
 - spec/data/html/converted_basic_haml.html
 - spec/data/html/converted_basic_slim.html
@@ -345,11 +394,13 @@ test_files:
 - spec/data/template_finder/automated/common.haml
 - spec/data/template_finder/custom/common.haml
 - spec/data/template_finder/custom/custom.slim
+- spec/lib/reveal-ck/builder_spec.rb
 - spec/lib/reveal-ck/config_spec.rb
 - spec/lib/reveal-ck/file_slicer_spec.rb
 - spec/lib/reveal-ck/file_splicer_spec.rb
 - spec/lib/reveal-ck/file_string_replacer_spec.rb
 - spec/lib/reveal-ck/presentation_builder_spec.rb
+- spec/lib/reveal-ck/presentation_dsl_spec.rb
 - spec/lib/reveal-ck/presentation_spec.rb
 - spec/lib/reveal-ck/slide_spec.rb
 - spec/lib/reveal-ck/slides_html_builder_spec.rb