reveal-ck 0.1.6 → 0.1.7

data/lib/reveal-ck/presentation.rb

@@ -1,30 +1,39 @@
 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.
+  # Public: A Presentation is slide html and metadata. Access html via
+  # #html. Access metadata via theme, title, author, transition.
   #
   class Presentation
 
-    attr_accessor :theme, :title, :author
+    include Config
+
+    attr_accessor :html
 
     def initialize
-      @slides = []
-      @theme = 'default'
+      @html = ''
+    end
+
+    def add(content)
+      @html << content.html
+    end
+
+    def self.from_template(path)
+      presentation = Presentation.new
+      template = Templates::Processor.open path
+      presentation.html = template.output({})
+      presentation
     end
 
-    def add_slide(slide)
-      @slides << slide
+    def self.from_dsl(path)
+      RevealCK::PresentationDSL.load path
     end
 
-    def content
-      content = ''
-      @slides.each do |slide|
-        content << slide.html
-        content << "\n\n"
+    def self.load(path)
+      if path.end_with? '.rb'
+        Presentation.from_dsl path
+      else
+        Presentation.from_template path
       end
-      content
     end
 
   end

data/lib/reveal-ck/presentation_dsl.rb

@@ -5,35 +5,44 @@ module RevealCK
   #
   class PresentationDSL
 
+    attr_reader :author, :title, :theme, :transition
+
     def initialize
       @slides = []
     end
 
-    def theme(theme = 'default')
+    def theme(theme)
       @theme = theme
     end
 
-    def title(title = 'Slides')
+    def transition(transition)
+      @transition = transition
+    end
+
+    def title(title)
       @title = title
     end
 
-    def author(author = '')
+    def author(author)
       @author = author
     end
 
-    def slide(template, variables)
+    def slide(template, variables = {})
       variables[:template] = template
       @slides << RevealCK::Slide.new(variables)
     end
 
+    def contents_of(path)
+      File.open(path).read
+    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.theme = @theme if @theme
+      presentation.transition = @transition if @transition
+      presentation.author = @author if @author
+      presentation.title = @title if @title
+      @slides.each { |slide| presentation.add slide }
       presentation
     end
 
@@ -46,8 +55,7 @@ module RevealCK
     def self.load(file)
       builder = PresentationDSL.new
       contents = File.open(file).read
-      result = builder.instance_eval contents
-      result
+      builder.instance_eval(contents)
     end
 
   end

data/lib/reveal-ck/slide.rb

@@ -7,13 +7,13 @@ module RevealCK
 
     def initialize(args)
       template = args[:template] || raise(':template is required')
-      file = TemplateFinder.new.find template
-      @template = TemplateProcessor.open file
+      file = Templates::Finder.new.find template
+      @template = Templates::Processor.open file
       @variables = args
     end
 
     def html
-      @template.output({}, @variables)
+      @template.output(@variables)
     end
 
   end

data/lib/reveal-ck/templates.rb

@@ -0,0 +1,3 @@
+require_relative 'templates/finder'
+require_relative 'templates/render_scope'
+require_relative 'templates/processor'

data/lib/reveal-ck/templates/finder.rb

@@ -0,0 +1,35 @@
+module RevealCK
+  module Templates
+    #
+    # Public: This class is home to a simple algorithm for looking up
+    # files in a series of directories. Directory order matters, and the
+    # first match for the file will be returned. It'll raise if it can't
+    # find the file you've asked for.
+    #
+    class Finder
+
+      attr_reader :paths
+
+      def initialize(args = {})
+        @paths = args[:paths] || default_paths
+      end
+
+      def default_paths
+        pwd_templates = File.join Dir.pwd, 'templates'
+        reveal_ck_templates = File.join RevealCK::LOCATION, 'templates'
+        [pwd_templates, reveal_ck_templates]
+      end
+
+      def find(template_name)
+        paths.each do |path|
+          glob_pattern = "#{File.join(path, template_name)}*"
+          Dir.glob(glob_pattern).each do |match|
+            return match unless File.directory? match
+          end
+        end
+        raise "Unable to find #{template_name} in #{paths}"
+      end
+
+    end
+  end
+end

data/lib/reveal-ck/templates/processor.rb

@@ -0,0 +1,32 @@
+#
+# Setup Slim
+require 'slim'
+::Slim::Engine.set_default_options pretty: true
+
+module RevealCK
+  module Templates
+    #
+    # Public: A Processor is given a template and expected to render
+    # it.
+    #
+    class Processor
+
+      require 'tilt'
+
+      def initialize(file)
+        @template = Tilt.new file
+      end
+
+      def output(locals = {})
+        scope = RenderScope.new
+        @template.render scope, locals
+      end
+
+      def self.open(file)
+        Processor.new file
+      end
+
+    end
+
+  end
+end

data/lib/reveal-ck/templates/render_scope.rb

@@ -0,0 +1,14 @@
+module RevealCK
+  module Templates
+    #
+    # Public: A new instance of RenderScope is created and made
+    # available when templates are rendered. Instance methods on it
+    # are availale to templates.
+    #
+    class RenderScope
+      def contents_of(path)
+        File.open(path).read
+      end
+    end
+  end
+end

data/lib/reveal-ck/version.rb

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

data/rakelib/examples.rake

@@ -0,0 +1,7 @@
+desc 'Exercise reveal-ck examples'
+task :examples do
+  examples = FileList["examples/*"]
+  examples.each do |example|
+    load example
+  end
+end

data/spec/data/config/full_config.toml

@@ -0,0 +1,7 @@
+title      = "The Never Sea Slides"
+author     = "Captain Hook"
+
+[presentation]
+
+theme      = "night"
+transition = "page"

data/spec/data/config/partial_config.toml

@@ -0,0 +1 @@
+title = "The Never Sea Slides"

data/spec/data/presentation/slides.haml

@@ -0,0 +1,2 @@
+%section
+  slides.haml

data/spec/data/presentation/slides.rb

@@ -0,0 +1,5 @@
+presentation do
+  theme 'night'
+  slide 'text',
+    content: 'slides.rb'
+end

data/spec/data/{dsl/slides.rb → presentation_dsl/dsl.rb}

@@ -3,10 +3,14 @@ presentation do
   title  'Presentation Title'
   author 'Presentation Author'
   theme  'night'
+  transition 'page'
 
   slide 'text',
     content: 'Hello World'
 
+  slide 'code',
+    content: contents_of('lib/reveal-ck.rb')
+
   slide 'text',
     content: 'Thanks!'
 

data/spec/data/templates/finder/code/function.rb

@@ -0,0 +1,3 @@
+def two
+  2
+end

data/spec/data/templates/render_scope/quote

@@ -0,0 +1,2 @@
+Whatever you can do or dream you can, begin it. Boldness has genius,
+power and magic in it.

data/spec/examples/programmatic_slides_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'examples/programmatic_slides.rb' do
+
+  it 'prints output from a presentation with several slides' do
+    expect($stdout).to receive :puts
+    expect {
+      load 'examples/programmatic_slides.rb'
+    }.to_not raise_error
+  end
+
+end

data/spec/examples/slide_output_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'examples/slide_output.rb' do
+
+  it 'prints output from a single slide' do
+    expect($stdout).to receive :puts
+    expect {
+      load 'examples/slide_output.rb'
+    }.to_not raise_error
+  end
+
+end

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

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module RevealCK
+  module Builders
+
+    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
+end

data/spec/lib/reveal-ck/builders/packaged_slides_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'tmpdir'
+
+module RevealCK
+  module Builders
+    describe PackagedSlides do
+
+      let :presentation do
+        presentation = Presentation.new
+        presentation.title = "Presentation Title"
+        presentation.author = "Presentation Author"
+
+        presentation.add(Slide.new({
+                                     template: 'intro',
+                                     title:    presentation.title,
+                                     author:   presentation.author,
+                                     site:     'http://site.com',
+                                     twitter:  'twitter'
+                                   }))
+        presentation
+      end
+
+      it 'can build reveal.js slides from a Presentation' do
+
+        tmp_dir = Dir.mktmpdir
+
+        packaged_slides =
+          PackagedSlides.new({
+                               presentation: presentation,
+                               output_dir: tmp_dir,
+                             })
+        packaged_slides.build!
+
+        expect(File.exists? File.join(tmp_dir, "index.html")).to be_true
+      end
+
+    end
+  end
+end

data/spec/lib/reveal-ck/changers/slicer_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'fileutils'
+require 'tmpdir'
+
+module RevealCK
+  module Changers
+    describe Slicer do
+
+      describe '.remove!' do
+
+        let :before_remove do
+          spec_data 'changers', 'slicer', 'before_remove'
+        end
+
+        let :after_remove do
+          spec_data 'changers', 'slicer', 'after_remove'
+        end
+
+        it 'removes a range of lines from a file' do
+          Dir.mktmpdir do |tmp_dir|
+            FileUtils.cp before_remove, tmp_dir
+            test_file = File.join tmp_dir, 'before_remove'
+            Slicer.remove! test_file, 3..6
+            test_file_contents = File.open(test_file).read
+            after_remove_contents = File.open(after_remove).read
+            test_file_contents.should == after_remove_contents
+          end
+        end
+      end
+
+      describe '#remove' do
+
+        it 'returns lines with the range removed' do
+          lines = [
+                   'a',
+                   'b',
+                   'c',
+                   'd'
+                  ]
+          slicer = Slicer.new lines
+          slicer.remove(1..2).should == ['a', 'd']
+        end
+      end
+    end
+  end
+end