magic_reveal 2.6.1.2 → 2.6.1.4

data/lib/magic_reveal/slide_renderer.rb

@@ -4,6 +4,7 @@ require 'cgi'
 require 'magic_reveal/version'
 
 module MagicReveal
+  # Custom renderer so the HTML is the right format for Reveal.js.
   class SlideRenderer < Redcarpet::Render::HTML
     include Redcarpet::Render::SmartyPants
     attr_accessor :has_shown_slides
@@ -14,11 +15,11 @@ module MagicReveal
 
     def self.markdown_renderer
       Redcarpet::Markdown.new(
-        self.new,
-        :space_after_headers => true,
-        :filter_html => true,
-        :fenced_code_blocks => true,
-        :no_intra_emphasis => true,
+        new,
+        space_after_headers: true,
+        filter_html: true,
+        fenced_code_blocks: true,
+        no_intra_emphasis: true
       )
     end
 
@@ -31,39 +32,34 @@ module MagicReveal
       has_shown_slides ? '</section>' : ''
     end
 
-    def header(text, header_level)
-      output = []
-      if has_shown_slides
-        output << "</section>"
-      else
+    def header(text, header_level, anchor = nil)
+      [].tap do |output|
+        output << '</section>' if has_shown_slides
         @has_shown_slides = true
-      end
-      output << "<section>"
-      output << "<h#{header_level}>#{text}</h#{header_level}>"
-      output.join("\n")
+        anchor_html = anchor ? " id=\"#{anchor}\"" : ''
+
+        output << '<section>'
+        output << "<h#{header_level}#{anchor_html}>#{text}</h#{header_level}>"
+      end.join("\n")
     end
 
     def prepare_code(code)
-      if code =~ %r{\A\s*@@source\s*=\s*(.*)\s*\Z}
-        File.read($1)
+      if code =~ /\A\s*@@source\s*=\s*(?<filename>.*)\s*\Z/
+        File.read Regexp.last_match[:filename]
       else
-        code.sub(%r{\A\s*}, '').sub(%r{\s*\Z}, '')
+        code.sub(/\A\s*/, '').sub(/\s*\Z/, '')
       end
     end
 
     def block_code(code, language)
-      output = []
-      if language
-        output << "<pre class=\"#{language}\">"
-      else
-        output << "<pre>"
-      end
-      output << "<code>"
+      [].tap do |output|
+        output << (language ? "<pre class=\"#{language}\">"  : '<pre>')
+        output << '<code>'
 
-      output << CGI::escapeHTML(prepare_code code)
-      output << "</code>"
-      output << "</pre>"
-      output.join("")
+        output << CGI.escapeHTML(prepare_code code)
+        output << '</code>'
+        output << '</pre>'
+      end.join('')
     end
   end
 end

data/lib/magic_reveal/version.rb

@@ -1,4 +1,5 @@
+# Version information
 module MagicReveal
   REVEAL_JS_VERSION = '2.6.1'
-  VERSION = "#{REVEAL_JS_VERSION}.2"
+  VERSION = "#{REVEAL_JS_VERSION}.4"
 end

data/magic-reveal.gemspec

@@ -4,45 +4,41 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'magic_reveal/version'
 
 Gem::Specification.new do |spec|
-  spec.name                  = "magic_reveal"
+  spec.name                  = 'magic_reveal'
   spec.version               = MagicReveal::VERSION
-  spec.authors               = ["Christian Höltje"]
-  spec.email                 = ["docwhat@gerf.org"]
+  spec.authors               = ['Christian Höltje']
+  spec.email                 = ['docwhat@gerf.org']
   spec.description           = %q{Create presentations with markdown and ease!}
   spec.summary               = %q{Create presentations using markdown and reveal.js}
-  spec.homepage              = "https://github.com/docwhat/magic_reveal"
-  spec.license               = "MIT"
+  spec.homepage              = 'https://github.com/docwhat/magic_reveal'
+  spec.license               = 'MIT'
 
-  spec.files                 = `git ls-files`.split($/)
+  spec.files                 = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths         = ["lib"]
+  spec.require_paths         = ['lib']
 
-  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_dependency             "sinatra",     "~> 1.4"
-  spec.add_dependency             "redcarpet",   "~> 3.0"
-  spec.add_dependency             "archive-zip", "~> 0.6"
-  spec.add_dependency             "sys-admin",   "~> 1.6"
-  spec.add_dependency             "nokogiri",    "~> 1.5"
-  spec.add_dependency             "highline",    "~> 1.6"
+  spec.add_dependency             'sinatra',        '~> 1.4'
+  spec.add_dependency             'redcarpet',      '~> 3.0'
+  spec.add_dependency             'archive-zip',    '~> 0.6'
+  spec.add_dependency             'sys-admin',      '~> 1.6'
+  spec.add_dependency             'nokogiri',       '~> 1.5'
+  spec.add_dependency             'highline',       '~> 1.6'
 
-  spec.add_development_dependency "bundler",     "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "guard",       "~> 1.8"
-  spec.add_development_dependency "guard-rspec", "~> 3.0"
-  spec.add_development_dependency "rspec",       "~> 2.14"
-  spec.add_development_dependency "faker"
-  spec.add_development_dependency "coveralls",   "~> 0.6"
-  spec.add_development_dependency "better_errors"
-  spec.add_development_dependency "binding_of_caller"
+  spec.add_development_dependency 'bundler',        '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'guard',          '~> 2.4'
+  spec.add_development_dependency 'guard-rspec',    '~> 4.2'
+  spec.add_development_dependency 'guard-rubocop',  '~> 1.0'
+  spec.add_development_dependency 'rspec',          '~> 2.14'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'coveralls',      '~> 0.7'
+  spec.add_development_dependency 'better_errors'
+  spec.add_development_dependency 'binding_of_caller'
 
-  #For detecting changes in the filesystem
-  spec.add_development_dependency 'rb-inotify'
-  spec.add_development_dependency 'rb-fsevent'
-  spec.add_development_dependency 'rb-fchange'
-
-  #For displaying notices
+  # For displaying notices
   spec.add_development_dependency 'terminal-notifier-guard'
   spec.add_development_dependency 'libnotify'
 end

data/spec/integration/renderer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'magic_reveal/slide_renderer'
+
+describe 'integration of SlideRenderer with Redcarpet' do
+  let(:markdown) do
+    return <<-EOF
+# Title
+
+Some text `here`.
+
+## Second level header
+
+```
+Fenced code goes here.
+```
+
+### Third level header
+
+    Indented code goes here.
+
+    EOF
+  end
+
+  it 'does not have errors' do
+    renderer = MagicReveal::SlideRenderer.markdown_renderer
+    expect(renderer.render markdown)
+      .to be_kind_of(String)
+  end
+end

data/spec/magic_reveal/cli/options_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'magic_reveal/cli/options'
 
 describe MagicReveal::Cli::Options do
-  describe ".parse" do
+  describe '.parse' do
     before { subject.parse args }
 
     context "given 'new <project>'" do
@@ -43,7 +43,7 @@ describe MagicReveal::Cli::Options do
       its(:command) { should be(:help) }
     end
 
-    context "given no arguments" do
+    context 'given no arguments' do
       let(:args) { [] }
 
       its(:command) { should be(:help) }

data/spec/magic_reveal/cli_spec.rb

@@ -1,35 +1,34 @@
 require 'spec_helper'
 require 'magic_reveal/cli'
 
-
 describe MagicReveal::Cli do
-  describe ".run" do
-    context "with a null options" do
+  describe '.run' do
+    context 'with a null options' do
       let(:options) { double(MagicReveal::Cli::Options).as_null_object }
-      let(:args) { double("ARGV") }
+      let(:args) { double('ARGV') }
       before do
         subject.stub(:show_help)
         subject.stub(:avenge_programmer)
         subject.stub(:options).and_return(options)
       end
 
-      context "command=nil" do
+      context 'command=nil' do
         before { subject.run args }
 
-        it "parses the args" do
+        it 'parses the args' do
           expect(options).to have_received(:parse).with(args)
         end
 
-        it "fetches the command" do
+        it 'fetches the command' do
           expect(options).to have_received(:command)
         end
 
-        it "avenges the programmer" do
+        it 'avenges the programmer' do
           expect(subject).to have_received(:avenge_programmer)
         end
       end
 
-      context "command=new" do
+      context 'command=new' do
         let(:creator) { double(MagicReveal::Creator).as_null_object }
         before do
           subject.creator = creator
@@ -37,19 +36,19 @@ describe MagicReveal::Cli do
           subject.run args
         end
 
-        it "fetches the project" do
+        it 'fetches the project' do
           expect(options).to have_received(:project)
         end
 
-        it "creates the project" do
-          expect(creator).
-            to have_received(:create_project).
-            with(options.project)
+        it 'creates the project' do
+          expect(creator)
+            .to have_received(:create_project)
+            .with(options.project)
         end
       end
 
-      context "command=help" do
-        it "shows help" do
+      context 'command=help' do
+        it 'shows help' do
           subject.stub(:show_help)
           subject.should_receive(:show_help).and_return(nil)
           options.stub(:command).and_return(:help)
@@ -57,8 +56,8 @@ describe MagicReveal::Cli do
         end
       end
 
-      context "command=start" do
-        it "starts the server" do
+      context 'command=start' do
+        it 'starts the server' do
           subject.stub(:start_server)
           subject.should_receive(:start_server).and_return(nil)
           options.stub(:command).and_return(:start)
@@ -66,8 +65,8 @@ describe MagicReveal::Cli do
         end
       end
 
-      context "command=static" do
-        it "creates a static file" do
+      context 'command=static' do
+        it 'creates a static file' do
           subject.stub(:create_static)
           subject.should_receive(:create_static).and_return(nil)
           options.stub(:command).and_return(:static)
@@ -77,17 +76,16 @@ describe MagicReveal::Cli do
     end
   end
 
-  describe ".creator" do
-    it "sends new to creator" do
+  describe '.creator' do
+    it 'sends new to creator' do
       MagicReveal::Creator.should_receive(:new).with(Dir.getwd)
       subject.creator
     end
   end
 
-  describe ".options" do
+  describe '.options' do
     it "responds to 'parse'" do
       subject.options.should respond_to(:parse)
     end
   end
-
 end

data/spec/magic_reveal/conductor_spec.rb

@@ -13,29 +13,29 @@ describe MagicReveal::Conductor do
 
   its(:url) { should be_kind_of(URI) }
 
-  describe ".fetch" do
-    it "should save a file" do
-      subject.url = "http://google.com/"
+  describe '.fetch' do
+    it 'should save a file' do
+      subject.url = 'http://google.com/'
       save_file = @tmpdir + 'index.html'
       subject.fetch save_file
       save_file.should exist
     end
   end
 
-  describe ".unpack" do
+  describe '.unpack' do
     let(:unpack_dir) { @tmpdir + "unpack-#{rand 200}" }
-    context "given a zipfile" do
+    context 'given a zipfile' do
       let(:zipfile) { EXAMPLE_DATA + 'wrapped.zip' }
 
-      it "unpacks and unwraps the zipfile" do
+      it 'unpacks and unwraps the zipfile' do
         subject.unpack zipfile, unpack_dir
         (unpack_dir + 'testfile.md').should exist
       end
 
-      context "and the unpack directory exists already" do
+      context 'and the unpack directory exists already' do
         before { unpack_dir.mkdir }
 
-        it "should raise an error" do
+        it 'should raise an error' do
           expect { subject.unpack zipfile, unpack_dir }.to raise_error(MagicReveal::Error)
         end
       end

data/spec/magic_reveal/creator_spec.rb

@@ -9,39 +9,44 @@ describe MagicReveal::Creator do
     subject.reveal_js_fetcher = fetcher
   end
 
-  context "with a temporary directory" do
+  context 'with a temporary directory' do
     subject { described_class.new @tmpdir }
-    around { |example| Dir.mktmpdir { |dir| @tmpdir = Pathname.new dir; example.run } }
+    around do |example|
+      Dir.mktmpdir do |dir|
+        @tmpdir = Pathname.new dir
+        example.run
+      end
+    end
 
     its(:directory) { should eq(@tmpdir) }
 
-    describe "create_project" do
+    describe 'create_project' do
       let(:project) { "project#{rand 99}" }
       before do
         FileUtils.stub(:copy_file)
         Pathname.any_instance.stub(:children).and_return([])
       end
 
-      it "makes the project directory" do
+      it 'makes the project directory' do
         subject.create_project(project)
         expect(@tmpdir + project).to be_directory
       end
 
-      it "fetches and saves reveal.js" do
+      it 'fetches and saves reveal.js' do
         subject.create_project(project)
-        expect(fetcher).
-          to have_received(:save_important_parts_to).
-          with(@tmpdir + project)
+        expect(fetcher)
+          .to have_received(:save_important_parts_to)
+          .with(@tmpdir + project)
       end
 
-      it "copies the template_slides" do
+      it 'copies the template_slides' do
         src = subject.template_slides
         dst = @tmpdir + project + 'slides.md'
         FileUtils.should_receive(:copy_file).with(src.to_s, dst.to_s)
         subject.create_project(project)
       end
 
-      it "copies the template_config_ru" do
+      it 'copies the template_config_ru' do
         src = subject.template_config_ru
         dst = @tmpdir + project + 'config.ru'
         FileUtils.should_receive(:copy_file).with(src.to_s, dst.to_s)
@@ -49,23 +54,23 @@ describe MagicReveal::Creator do
       end
     end
 
-    describe "update_project" do
+    describe 'update_project' do
       let(:project) { @tmpdir + "project#{rand 99}" }
 
-      it "fetches and saves reveal.js" do
+      it 'fetches and saves reveal.js' do
         subject.update_project(project)
-        expect(fetcher).
-          to have_received(:save_important_parts_to).
-          with(project)
+        expect(fetcher)
+          .to have_received(:save_important_parts_to)
+          .with(project)
       end
     end
 
-    describe ".template_slides" do
+    describe '.template_slides' do
       its(:template_slides) { should be_kind_of(Pathname) }
       its(:template_slides) { should be_file }
     end
 
-    describe ".template_config_ru" do
+    describe '.template_config_ru' do
       its(:template_config_ru) { should be_kind_of(Pathname) }
       its(:template_config_ru) { should be_file }
     end

data/spec/magic_reveal/identifier_spec.rb

@@ -5,55 +5,55 @@ describe MagicReveal::Identifier do
   subject { described_class.new sys_admin }
   let(:sys_admin) { double(Sys::Admin).as_null_object }
 
-  describe ".name" do
+  describe '.name' do
     before do
       sys_admin.stub(:respond_to?)
     end
 
-    it "gets the login" do
+    it 'gets the login' do
       subject.name
       expect(sys_admin).to have_received(:get_login)
     end
 
-    it "passes the login to get_user" do
+    it 'passes the login to get_user' do
       subject.name
       expect(sys_admin).to have_received(:get_user).with(sys_admin.get_login)
     end
 
-    context "the user has a full_name" do
+    context 'the user has a full_name' do
       let(:user) { double(Sys::Admin::User) }
       before do
         sys_admin.stub(:get_user).with(sys_admin.get_login).and_return(user)
         sys_admin.stub(:respond_to?).with(:full_name).and_return(true)
       end
 
-      it "returns the full_name" do
-        name = double("full_name")
+      it 'returns the full_name' do
+        name = double('full_name')
         user.should receive(:full_name).and_return(name)
         expect(subject.name).to eq(name)
       end
     end
 
-    context "the user has a simple gecos" do
+    context 'the user has a simple gecos' do
       let(:user) { double(Sys::Admin::User) }
       before do
         sys_admin.stub(:get_user).with(sys_admin.get_login).and_return(user)
       end
 
-      it "returns the gecos" do
+      it 'returns the gecos' do
         gecos = "Joe Cool #{rand 99}"
         user.should receive(:gecos).and_return(gecos)
         expect(subject.name).to eq(gecos)
       end
     end
 
-    context "the user has a comma-delimited gecos" do
+    context 'the user has a comma-delimited gecos' do
       let(:user) { double(Sys::Admin::User) }
       before do
         sys_admin.stub(:get_user).with(sys_admin.get_login).and_return(user)
       end
 
-      it "returns the gecos" do
+      it 'returns the gecos' do
         name = "Joe Cool #{rand 99}"
         gecos = "#{name},White House,412 555-1212,"
         user.should receive(:gecos).and_return(gecos)
@@ -61,35 +61,35 @@ describe MagicReveal::Identifier do
       end
     end
 
-    context "the user has an empty comma-delimited gecos" do
-      it "returns the gecos" do
+    context 'the user has an empty comma-delimited gecos' do
+      it 'returns the gecos' do
         login = "joecool#{rand 99}"
         user = double(Sys::Admin::User)
 
         sys_admin.stub(:get_login).and_return(login)
         sys_admin.stub(:get_user).with(login).and_return(user)
 
-        user.should receive(:gecos).and_return(",,,")
+        user.should receive(:gecos).and_return(',,,')
         expect(subject.name).to eq(login)
       end
     end
 
-    context "the user has an empty gecos" do
-      it "returns the gecos" do
+    context 'the user has an empty gecos' do
+      it 'returns the gecos' do
         login = "joecool#{rand 99}"
         user = double(Sys::Admin::User)
 
         sys_admin.stub(:get_login).and_return(login)
         sys_admin.stub(:get_user).with(login).and_return(user)
 
-        user.should receive(:gecos).and_return("")
+        user.should receive(:gecos).and_return('')
         expect(subject.name).to eq(login)
       end
     end
   end
 
-  describe "#name (an alias)" do
-    it "calls .name on an instance" do
+  describe '#name (an alias)' do
+    it 'calls .name on an instance' do
       instance = double(described_class).as_null_object
       described_class.stub(:new).and_return(instance)
       expect(described_class.name).to be(instance.name)