reveal-ck 0.3.0 → 0.4.0

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

@@ -7,12 +7,13 @@ module RevealCK
     # file to work with, and a place to put it all.. this class
     # creates a presentation.
     class SlidesBuilder < CreationTask
-      attr_reader :reveal_js_dir, :reveal_ck_dir
+      attr_reader :user_dir, :gem_dir, :reveal_js_dir
       attr_reader :slides_file, :output_dir
       attr_reader :application
       def initialize(args)
-        @reveal_js_dir = retrieve(:reveal_js_dir, args)
-        @reveal_ck_dir = retrieve(:reveal_ck_dir, args)
+        @user_dir = retrieve(:user_dir, args)
+        @gem_dir = retrieve(:gem_dir, args)
+        @reveal_js_dir = File.join(gem_dir, 'files', 'reveal.js')
         @output_dir = retrieve(:output_dir, args)
         @slides_file = retrieve(:slides_file, args)
         @application = Rake::Application.new
@@ -32,7 +33,7 @@ module RevealCK
       end
 
       def read_config
-        config_file = File.join(reveal_ck_dir, 'config.yml')
+        config_file = File.join(user_dir, 'config.yml')
         return unless File.exist?(config_file)
         config_as_hash = YAML.load_file config_file
         @config.merge!(config_as_hash)
@@ -40,25 +41,33 @@ module RevealCK
 
       def dependencies
         [copy_user_files,
-         copy_reveal_js,
+         copy_reveal_ck_files,
+         copy_reveal_js_files,
          create_slides_html,
          create_index_html]
       end
 
-      def copy_user_files
-        file_listing = UserFiles.new(dir: reveal_ck_dir)
+      def copy_files(file_listing)
         task = CopyFilesTask.new(file_listing: file_listing,
                                  output_dir: output_dir,
                                  application: application)
         task.prepare
       end
 
-      def copy_reveal_js
-        file_listing = RevealJsFiles.new(dir: reveal_js_dir)
-        task = CopyFilesTask.new(file_listing: file_listing,
-                                 output_dir: output_dir,
-                                 application: application)
-        task.prepare
+      def copy_user_files
+        user_files = UserFiles.new(dir: user_dir)
+        copy_files(user_files)
+      end
+
+      def copy_reveal_ck_files
+        reveal_ck_files_dir = File.join(gem_dir, 'files', 'reveal-ck')
+        reveal_ck_files = RevealCkFiles.new(dir: reveal_ck_files_dir)
+        copy_files(reveal_ck_files)
+      end
+
+      def copy_reveal_js_files
+        reveal_js_files = RevealJsFiles.new(dir: reveal_js_dir)
+        copy_files(reveal_js_files)
       end
 
       def create_slides_html
@@ -71,12 +80,12 @@ module RevealCK
       end
 
       def create_index_html
-        index_html_erb = RevealCK.path_to('templates',
-                                          'reveal.js',
-                                          'index.html.erb')
+        index_html_erb =
+          RevealCK.template_path('index.html',
+                                 'index.html.erb')
         task =
           CreateIndexHtml.new(slides_html: "#{output_dir}/slides.html",
-                              index_html: index_html_erb,
+                              template: index_html_erb,
                               output_dir: output_dir,
                               config: @config,
                               application: application)

data/lib/reveal-ck/config.rb

@@ -6,7 +6,7 @@ module RevealCK
   # reveal-ck. It has defaults. It is mutable.
   class Config < OpenStruct
     def initialize
-      super DEFAULTS
+      super defaults
     end
 
     def merge!(hash)
@@ -15,20 +15,43 @@ module RevealCK
       end
     end
 
-    DEFAULTS = {
-      'title'      => 'Slides',
-      'author'     => '',
-      'theme'      => 'default',
-      'transition' => 'default',
-      'revealjs_config' => {
-        'controls' => true,
-        'progress' => true,
-        'history' => true,
-        'center' => true
-      },
-      'data' => {
+    def defaults
+      [core_defaults,
+       revealjs_config_defaults,
+       filter_defaults].reduce({}) { |a, e| a.merge(e) }
+    end
+
+    def core_defaults
+      {
+        'title'      => 'Slides',
+        'author'     => '',
+        'theme'      => 'default',
+        'transition' => 'default',
+        'data' => {
+
+        }
+      }
+    end
 
+    def revealjs_config_defaults
+      {
+        'revealjs_config' => {
+          'controls' => true,
+          'progress' => true,
+          'history' => true,
+          'center' => true
+        }
       }
-    }
+    end
+
+    def filter_defaults
+      {
+        'filters' => ['HTML::Pipeline::RevealCKEmojiFilter',
+                      'HTML::Pipeline::MentionFilter',
+                      'HTML::Pipeline::AutolinkFilter'],
+        'asset_root' => 'https://assets-cdn.github.com/images/icons/',
+        'base_url' => 'https://github.com'
+      }
+    end
   end
 end

data/lib/reveal-ck/filtered_html_string.rb

@@ -0,0 +1,24 @@
+module RevealCK
+  # Enables easy filtering of an HTML string through an html-pipeline.
+  class FilteredHtmlString
+    include Retrieve
+    attr_reader :html, :pipeline, :config
+
+    def initialize(args)
+      @html = retrieve(:html, args)
+      @pipeline = retrieve(:pipeline, args)
+      @config = retrieve(:config, args)
+    end
+
+    def render
+      apply_pipeline(pipeline, config).to_s
+    end
+
+    private
+
+    def apply_pipeline(pipeline, config)
+      result = pipeline.call(html, config)
+      result[:output]
+    end
+  end
+end

data/lib/reveal-ck/markdown/slide_markdown.rb

@@ -2,11 +2,7 @@ require 'redcarpet'
 
 module RevealCK
   module Markdown
-    #
-    # Public: This class defines what "Slide Markdown" is: an
-    # extension of regular Redcarpet Markdown with some basic post
-    # processing.
-    #
+    # This class defines what "Slide Markdown" is.
     class SlideMarkdown < Redcarpet::Render::HTML
       HR = '<hr>'
       HR_NEWLINE = "<hr>\n"
@@ -24,6 +20,16 @@ module RevealCK
         doc = doc.gsub(HR, SLIDE_DIVIDER)
         "#{SLIDE_START}\n#{doc}\n#{SLIDE_END}"
       end
+
+      def block_code(code, language)
+        if language.nil?
+          "<pre><code>#{code}</code></pre>"
+        elsif language == 'notes' || language == 'note'
+          "<aside class='notes'>#{code}</aside>"
+        else
+          "<pre><code class=\"#{language}\">#{code}</code></pre>"
+        end
+      end
     end
   end
 end

data/lib/reveal-ck/render/index_html_maker.rb

@@ -5,17 +5,17 @@ module RevealCK
     # An IndexHtml is made by composed head, body, and script.
     module IndexHtmlMaker
       def head
-        head_html_erb = RevealCK.path_to('templates',
-                                         'reveal.js',
-                                         'head.html.erb')
+        head_html_erb =
+          RevealCK.template_path('index.html',
+                                 'head.html.erb')
         template = Tilt.new(head_html_erb)
         template.render(self)
       end
 
       def body(slides_html)
-        body_html_erb = RevealCK.path_to('templates',
-                                         'reveal.js',
-                                         'body.html.erb')
+        body_html_erb =
+          RevealCK.template_path('index.html',
+                                 'body.html.erb')
         template = Tilt.new(body_html_erb)
         locals = {
           slides_html: slides_html
@@ -24,9 +24,9 @@ module RevealCK
       end
 
       def script
-        script_js_erb = RevealCK.path_to('templates',
-                                         'reveal.js',
-                                         'script.js.erb')
+        script_js_erb =
+          RevealCK.template_path('index.html',
+                                 'script.js.erb')
         template = Tilt.new(script_js_erb)
         template.render(self)
       end

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

@@ -15,7 +15,8 @@ module RevealCK
 
       def default_paths
         pwd_templates = File.join Dir.pwd, 'templates'
-        reveal_ck_templates = RevealCK.path_to 'templates'
+        reveal_ck_templates =
+          RevealCK.template_path('slides')
         [pwd_templates, reveal_ck_templates]
       end
 

data/lib/reveal-ck/version.rb

@@ -1,4 +1,4 @@
 # RevealCK::VERSION is the current version of reveal-ck
 module RevealCK
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

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

@@ -18,12 +18,12 @@ module RevealCK
       let :file_listing do
         file_listing = double
 
-        file_listing
-          .stub(:files)
+        allow(file_listing)
+          .to receive(:files)
           .and_return([file_a_source, file_b_source])
 
-        file_listing
-          .stub(:dir)
+        allow(file_listing)
+          .to receive(:dir)
           .and_return(source_dir)
 
         file_listing

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

@@ -17,12 +17,13 @@ module RevealCK
             end
 
             index_html_erb =
-              RevealCK.path_to('templates/reveal.js/index.html.erb')
+              RevealCK.template_path('index.html',
+                                     'index.html.erb')
 
             application = Rake::Application.new
             create_index_html =
               CreateIndexHtml.new(slides_html: slides_html,
-                                  index_html: index_html_erb,
+                                  template: index_html_erb,
                                   output_dir: dir,
                                   config: Config.new,
                                   application: application)

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

@@ -30,6 +30,32 @@ module RevealCK
           end
         end
       end
+
+      it 'can transform emoji' do
+        Dir.mktmpdir do |dir|
+          Dir.chdir(dir) do
+
+            slides_file_initial = 'slides-initial.md'
+            File.open(slides_file_initial, 'w') do |file|
+              file.puts('# I :heart: Slides')
+            end
+
+            config = Config.new
+            config.filters = ['HTML::Pipeline::RevealCKEmojiFilter']
+            application = Rake::Application.new
+            slides_html =
+              CreateSlidesHtml.new(slides_file: slides_file_initial,
+                                   output_dir: dir,
+                                   config: config,
+                                   application: application)
+
+            slides_html.prepare
+            application['create_slides_html'].invoke
+            content = File.open('slides.html', 'r').read
+            expect(content).to include 'emoji/heart.png'
+          end
+        end
+      end
     end
   end
 end

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

@@ -4,7 +4,8 @@ module RevealCK
   module Builders
     describe IndexHtml do
       let :index_html_erb do
-        File.join(Dir.pwd, 'templates', 'reveal.js', 'index.html.erb')
+        RevealCK.template_path('index.html',
+                               'index.html.erb')
       end
 
       let :slides_html do
@@ -21,7 +22,7 @@ module RevealCK
       end
 
       let :index_html do
-        IndexHtml.new(index_file: index_html_erb,
+        IndexHtml.new(template: index_html_erb,
                       slides_html: slides_html,
                       config: config)
       end
@@ -31,7 +32,7 @@ module RevealCK
       end
 
       it 'is created with a file location and a config' do
-        expect(index_html.index_file).to include 'index.html.erb'
+        expect(index_html.template).to include 'index.html.erb'
         expect(index_html.config.title).to eq config.title
       end
 

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

@@ -24,8 +24,8 @@ module RevealCK
             end
 
             args = {
-              reveal_js_dir: RevealCK.path_to('reveal.js'),
-              reveal_ck_dir: dir,
+              user_dir: dir,
+              gem_dir: RevealCK.path,
               output_dir: 'presentation',
               slides_file: slides_file
             }

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

@@ -5,7 +5,7 @@ module RevealCK
     describe UserFiles do
       describe '#all' do
         let :stand_in_user_files_dir do
-          File.join(Dir.pwd, 'reveal.js')
+          File.join(Dir.pwd, 'files', 'reveal.js')
         end
 
         let :user_files do

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

@@ -40,10 +40,28 @@ module RevealCK
         expect(config.transition).to eq 'default'
       end
 
-      it 'supplies an #transition, and #transition=' do
+      it 'supplies a #transition, and #transition=' do
         config.transition = 'page'
         expect(config.transition).to eq 'page'
       end
+
+      it 'supplies a default asset_root' do
+        expect(config.asset_root)
+          .to eq 'https://assets-cdn.github.com/images/icons/'
+      end
+
+      it 'supplies a default list of filters' do
+        expect(config.filters).to eq ['HTML::Pipeline::RevealCKEmojiFilter',
+                                      'HTML::Pipeline::MentionFilter',
+                                      'HTML::Pipeline::AutolinkFilter']
+      end
+
+      it 'does not share attributes between instances' do
+        first = Config.new
+        first.filters << 'A'
+        second = Config.new
+        expect(second.filters).to_not include 'A'
+      end
     end
 
     describe 'revealjs_config options' do

data/spec/lib/reveal-ck/markdown/slide_markdown_spec.rb

@@ -8,67 +8,70 @@ module RevealCK
         SlideMarkdown.new
       end
 
-      let :basic_input do
-        <<-eos
-<h1>First Slide</h1>
+      describe '#postprocess' do
+        let :basic_input do
+          <<-eos
+<h1>h1 Slide</h1>
 
 <hr>
 
-<h1>Second Slide</h1>
+<h2>h2 Slide</h2>
 eos
-      end
+        end
 
-      let :leading_hr_input do
-        <<-eos
+        let :leading_hr_input do
+          <<-eos
 <hr>
 
-<h1>First Slide</h1>
+<h1>h1 Slide</h1>
 
 <hr>
 
-<h1>Second Slide</h1>
+<h2>h2 Slide</h2>
 eos
-      end
+        end
 
-      let :trailing_hr_input do
-        <<-eos
-<h1>First Slide</h1>
+        let :trailing_hr_input do
+          <<-eos
+<h1>h1 Slide</h1>
 
 <hr>
 
-<h1>Second Slide</h1>
+<h2>h2 Slide</h2>
 
 <hr>
 eos
+        end
+
+        it 'wraps its content in a <section>"' do
+          output = slide_markdown.postprocess(basic_input)
+          expect(output).to start_with '<section>'
+          expect(output).to end_with '</section>'
+          expect(output.scan('<section>').size).to eq 2
+          expect(output.scan('</section>').size).to eq 2
+        end
+
+        it 'replaces <hr> with section breaks' do
+          output = slide_markdown.postprocess(basic_input)
+          expect(output).to_not include 'hr'
+          expect(output).to include '<h1>h1 Slide</h1>'
+          expect(output).to include '<h2>h2 Slide</h2>'
+        end
+
+        it 'does not turn an initial <hr> into a section' do
+          output = slide_markdown.postprocess(leading_hr_input)
+          expect(output.scan('<section>').size).to eq 2
+          expect(output.scan('</section>').size).to eq 2
+          expect(output).to_not include 'hr'
+        end
+
+        it 'does not turn a trailing <hr> into a section' do
+          output = slide_markdown.postprocess(trailing_hr_input)
+          expect(output.scan('<section>').size).to eq 2
+          expect(output.scan('</section>').size).to eq 2
+          expect(output).to_not include 'hr'
+        end
       end
-
-      it 'prepends an opening "<section>"' do
-        output = slide_markdown.postprocess(basic_input)
-        output.should start_with '<section>'
-      end
-
-      it 'appends a closing "</section>"' do
-        output = slide_markdown.postprocess(basic_input)
-        output.should end_with '</section>'
-      end
-
-      it 'replaces "<hr>"s with section breaks' do
-        output = slide_markdown.postprocess(basic_input)
-        output.should include '<h1>First Slide</h1>'
-        output.should include "</section>\n<section>"
-        output.should include '<h1>Second Slide</h1>'
-      end
-
-      it 'trims off an initial <hr>' do
-        output = slide_markdown.postprocess(leading_hr_input)
-        output.should_not start_with "<section>\n</section>"
-      end
-
-      it 'trims off a trailing <hr>' do
-        output = slide_markdown.postprocess(trailing_hr_input)
-        output.should_not =~ /<section>\s*<\/section>/m
-      end
-
     end
   end
 end