reveal-ck 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d01a6401df8df2a518c8f1a4fd0de6602350466c
-  data.tar.gz: 6275bbbeea33d8433334bf70b98cc7c8923f9329
+  metadata.gz: aca8e4f58ee283bcbb087b5e1c2571581dc18ec8
+  data.tar.gz: d22da14cd95eb95b499456e4b2666426fb57d3d5
 SHA512:
-  metadata.gz: 0f973d4e4588fa716b013d124bb36386e45a6e374f008973378b3f16fabebe8180fd07286ebe2da04e08d4ebd4d89667bcff36c02cd59cd1eb94285a6900ceb8
-  data.tar.gz: 134953045dd3c84b5c2fce0eace04b98e45debc451274a32e3e65d0f22305764a49acd90f931a3095824bd28c79ababe6af06fc6dc7262fd18e7647a5e16f380
+  metadata.gz: 0ad11d5536cc9f1edbe489ac2f7c27208d836379e75d76686497ca9e92f94ec700b81daf7c078464ffc175031feb1c758619c2bf5f227c70dcc2cd1d17ff4643
+  data.tar.gz: 98a08d2e1b0a5ac2acde9552459dff3cdaddb7052a4cb1224c751427ecabcb33a48a7fcbdb4010fc6ba34c91ab5f3d199407a900407f04a29a780eb636ddf044

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2014 Jed Northridge, http://jednorthridge.com
+Copyright (c) 2013-2016 Jed Northridge, http://jedcn.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,166 +1,69 @@
 # Create Slides with Markdown
 
-[![Gem Version](https://badge.fury.io/rb/reveal-ck.svg)](http://badge.fury.io/rb/reveal-ck)
-[![Build Status](https://travis-ci.org/jedcn/reveal-ck.svg)](https://travis-ci.org/jedcn/reveal-ck)
-[![Code Climate](https://codeclimate.com/github/jedcn/reveal-ck/badges/gpa.svg)](https://codeclimate.com/github/jedcn/reveal-ck)
-[![Test Coverage](https://codeclimate.com/github/jedcn/reveal-ck/badges/coverage.svg)](https://codeclimate.com/github/jedcn/reveal-ck)
+## reveal-ck is..
 
-reveal-ck helps you author [reveal.js][reveal.js] presentations.
-
-You can create slides in numerous languages, but the most popular is
-Markdown. And not just any markdown-- it's markdown like you write on
-https://github.com, so it supports:
-
-* emoji (:money_with_wings:)
-* automatic links (https://github.com)
-* @mentions (@jedcn)
-* GFM tables
-
-## How do I get started?
-
-* Install [the reveal-ck gem][reveal-ck-gem]
-* Copy and paste the following, and save it in a file named
-  `slides.md`:
-```
-## i :heart: reveal.js
----
-## This is your
-* presentation
-* content
-* in a single file
----
-## Slides are Separated with `---`
----
-## Vertical Sections..
-Start and End with `***`
-***
-These
----
-Slides
----
-Are
----
-Vertical!!
-***
-## :zap: LiveReload is builtin :zap:
-with `reveal-ck serve`
----
-## :metal: emoji comes standard :money_with_wings:
----
-## What's up with the "-ck"?
-It stands for construction kit.
----
-# So, if you're not
-a fan of Markdown you can also use
-
-1. html
-2. erb
-3. haml
-4. slim
-5. ruby (DSL)
----
-## See also:
-http://jedcn.github.io/reveal-ck/
----
-## Might be helpful:
-https://relishapp.com/jedcn/reveal-ck/
-## Questions? Problems?
-Let me know, @jedcn
----
-# Thanks!
-```
-* Open a terminal and change to the directory with your new
-  `slides.md`
-* Run `reveal-ck generate` followed by `reveal-ck serve`. You should
-  see:
-```
-$ reveal-ck generate
-Generating slides for 'slides.md'..
-$ reveal-ck serve
-------------------------------------------------------------
-[ reveal-ck ] Serving up slide content in 'slides/'.
-[ reveal-ck ] Open your browser to 'http://localhost:10000'.
-[ reveal-ck ] Press CTRL-C to stop.
-------------------------------------------------------------
-[ reveal-ck ] Getting Ready to Reload Browsers.
-[   reload  ] Using Guardfile at ...
-[   reload  ] LiveReload is waiting for a browser to connect.
-[   reload  ] Guard is now watching at 'whereever'
-[ reveal-ck ] Getting Ready to Rebuild Slides.
-[ reveal-ck ] Starting Webserver.
-```
-
-Now view the slide deck generated from this single file by opening
-your browser to [http://localhost:10000][localhost].
-
-Check back at the terminal where the serve command is running and see
-that reveal-ck is aware that you're viewing your slides:
-
-```
-[   reload  ] Browser connected.
-```
-
-## And then?
-
-Use your editor and make a change to the `slides.md` file.
-
-reveal-ck will see the change, rebuild your slides, and reload your
-browser for you.
-
-As a final step *for now*, create a file named `config.yml` alongside
-the `slides.md` and add a single line:
-
-```
-theme: night
-```
-
-And your slides will take on the night theme from reveal.js.
-
----
-
-## What is it like?
-
-Here's a quick example of what it's like to work with reveal-ck:
-
-* Normally you'd use a text editor, but for brevity, this example
-  creates a file named `slides.md` with the `echo` command.
-* A presentation is then generated with `reveal-ck generate`.
-* That presentation is viewed with `open slides/index.html`. You'd
-  normally run a `reveal-ck serve` and then view
-  [https://localhost:10000][localhost]
-* Next, a theme is introduced by supplying a `config.yml` file.
-* That theme comes into play when the same presentation is generated
-  again.
-* Finally, the presentation is viewed again with `open slides/index.html`
-
-![Fast Introduction](https://jedcn.github.io/reveal-ck/images/reveal-ck-fast-intro.gif)
-
----
-
-## Where does this leave us?
-
-* reveal-ck helps you build reveal.js presentations
-* your content is stored in a single file so you can easily track it
-  (**with git**) and review it (**with your brain**)
-* write in markdown or the html-ish language of your choice
-
-If find these ideas intriguing, you can learn more at
-http://jedcn.github.io/reveal-ck/.
+a command line tool that helps you author [reveal.js][reveal.js]
+presentations.
 
-## Contributing
+[reveal.js]: http://lab.hakim.se/reveal-js
 
-If you'd like to log a bug, propose an issue, or get going with local
-development, please see [CONTRIBUTING.md](CONTRIBUTING.md).
+It lets you focus on the content of your presentation by taking care
+of the details of building a reveal.js presentation.
+
+You write your presentation in markdown, in a single file, and
+reveal-ck generates everything else.
+
+## Get Started Now
+
+Here's a [quick example][quick-example] so you can see what using
+reveal-ck is like.
+
+[quick-example]: docs/QUICK-EXAMPLE.md
+
+## Learning More
+
+There are many, many things you can do to customize your slides!
+
+Here's a long, but not exhaustive, list of things you can do:
+
+* Get fast feedback with LiveReload. Save your slides and instantly
+  see the result.
+* Host your slides up on Github Pages.
+* Use any emoji available on github, such as `:money_with_wings:`
+* Take advantage of reveal.js' vertical slides
+* Use Github Flavored Markdown Tables
+* Write your slides in HTML or popular Ruby templating languages, like
+  ERB and Haml, and Slim.
+* Easily support CSS tweaks.
+* Use `@mentions`, such as, @jedcn.
+* Manage configuration of themes and plugins in a single config file.
+* Integrate with `rake` (ie: create rake tasks that build slides)
+
+## Installation
+
+`reveal-ck` is delivered as a RubyGem, and so, you need Ruby 2.0+ and
+then installing should be as easy as:
+
+    gem install reveal-ck
+
+Verify that things are functional and you have the latest version of
+reveal-ck by typing:
+
+    reveal-ck --version
 
 ## Questions?
 
-If you have questions, find me on github ([@jedcn][github-jedcn]) or
-twitter ([@jedcn][twitter-jedcn]), open an issue, or email me at
-revealck@jedcn.com.
+Not everything is documented, and nothing is perfect, so-- if you'd
+like to [ask a question or log a bug please do so][new-issue]!
+
+[new-issue]: https://github.com/jedcn/reveal-ck/issues/new
+
+## Contributing
 
-[reveal.js]:     http://lab.hakim.se/reveal-js
-[github-jedcn]:  https://github.com/jedcn
-[twitter-jedcn]: https://twitter.com/jedcn
-[reveal-ck-gem]: https://rubygems.org/gems/reveal-ck
-[localhost]:     http://localhost:10000
-[github-pages]:  https://pages.github.com/
+[![Gem Version](https://badge.fury.io/rb/reveal-ck.svg)](http://badge.fury.io/rb/reveal-ck)
+[![Build Status](https://travis-ci.org/jedcn/reveal-ck.svg)](https://travis-ci.org/jedcn/reveal-ck)
+[![Code Climate](https://codeclimate.com/github/jedcn/reveal-ck/badges/gpa.svg)](https://codeclimate.com/github/jedcn/reveal-ck)
+[![Test Coverage](https://codeclimate.com/github/jedcn/reveal-ck/badges/coverage.svg)](https://codeclimate.com/github/jedcn/reveal-ck)
+
+If you're a ruby developer and you want to get going with local
+development, please see [CONTRIBUTING.md](CONTRIBUTING.md).

data/features/step_definitions/html_match_steps.rb

@@ -13,7 +13,7 @@ def check_doc_matches(doc, selector, description, type)
   return unless search_result.empty?
   message = "Could not find #{description}. "
   message += "No match for #{type} '#{selector}'"
-  fail message
+  raise message
 end
 
 Then(/^the file "(.*?)" should have html matching the css:$/) do |file, table|

data/lib/html/pipeline/reveal_ck_emoji_filter.rb

@@ -4,13 +4,8 @@ module HTML
     # width/height/align attributes so that reveal-ck supplied CSS
     # takes effect.
     class RevealCKEmojiFilter < EmojiFilter
-      def emoji_image_filter(text)
-        return text unless text.include?(':')
-
-        text.gsub(emoji_pattern) do
-          name = Regexp.last_match[1]
-          "<img class='emoji' alt=':#{name}:' src='#{emoji_url(name)}' />"
-        end
+      def emoji_image_tag(name)
+        "<img class='emoji' alt=':#{name}:' src='#{emoji_url(name)}' />"
       end
     end
   end

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

@@ -17,7 +17,8 @@ module RevealCK
       end
 
       def analyze_file(file)
-        dest = file.pathmap("%{^#{file_listing.dir}/,#{output_dir}/}p")
+        src_dir = Regexp.escape(file_listing.dir)
+        dest = file.pathmap("%{^#{src_dir}/,#{output_dir}/}p")
         copy_file(file, dest)
         dest_dir = dest.pathmap('%d')
         create_directory(dest_dir)

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

@@ -13,7 +13,7 @@ module RevealCK
       end
 
       def setup
-        fail('setup must be implemented by subclasses')
+        raise('setup must be implemented by subclasses')
       end
 
       def name

data/lib/reveal-ck/commands/serve_ui.rb

@@ -8,7 +8,7 @@ module RevealCK
         problem: '[  problem  ]',
         rebuild: '[  rebuild  ]',
         reload:  '[   reload  ]'
-      }
+      }.freeze
 
       def problem(general_problem, specific_error)
         blank :problem
@@ -29,7 +29,7 @@ module RevealCK
 
       def blank(type = nil)
         prefix = PREFIXES[type] || ''
-        puts "#{prefix}"
+        puts prefix.to_s
       end
 
       def separator

data/lib/reveal-ck/markdown.rb

@@ -2,10 +2,10 @@ module RevealCK
   # This module defines how reveal-ck works with redcarpet to produce
   # slides from markdown.
   module Markdown
-    REVEALCK_SYMBOL_FOR_DIVIDER          = '<div>DIVIDER</div>'
-    REVEALCK_SYMBOL_FOR_VERTICAL_START   = '<div>VERTICAL_START</div>'
-    REVEALCK_SYMBOL_FOR_VERTICAL_END     = '<div>VERTICAL_END</div>'
-    REVEALCK_SYMBOL_FOR_EMOJI_UNDERSCORE = 'EU'
+    REVEALCK_SYMBOL_FOR_DIVIDER          = '<div>DIVIDER</div>'.freeze
+    REVEALCK_SYMBOL_FOR_VERTICAL_START   = '<div>VERTICAL_START</div>'.freeze
+    REVEALCK_SYMBOL_FOR_VERTICAL_END     = '<div>VERTICAL_END</div>'.freeze
+    REVEALCK_SYMBOL_FOR_EMOJI_UNDERSCORE = 'EU'.freeze
   end
 end
 

data/lib/reveal-ck/rake_task.rb

@@ -60,9 +60,7 @@ module RevealCK
       desc 'Generate a reveal.js presentation' unless last_comment
       task name, *args do |_, task_args|
         RakeFileUtils.__send__(:verbose, verbose) do
-          if task_block
-            task_block.call(*[self, task_args].slice(0, task_block.arity))
-          end
+          yield(*[self, task_args].slice(0, task_block.arity)) if task_block
           run_task verbose
         end
       end

data/lib/reveal-ck/retrieve.rb

@@ -2,7 +2,7 @@ module RevealCK
   # Retrieve the value of a symbol from a hash or fail
   module Retrieve
     def retrieve(symbol, hash)
-      hash[symbol] || fail("#{symbol} is required")
+      hash[symbol] || raise("#{symbol} is required")
     end
 
     def self.included(base)

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

@@ -27,7 +27,7 @@ module RevealCK
             return match unless File.directory? match
           end
         end
-        fail "Unable to find #{template_name} in #{paths}"
+        raise "Unable to find #{template_name} in #{paths}"
       end
     end
   end

data/lib/reveal-ck/version.rb

@@ -1,4 +1,4 @@
 # RevealCK::VERSION is the current version of reveal-ck
 module RevealCK
-  VERSION = '3.3.0'
+  VERSION = '3.3.1'.freeze
 end

data/rakelib/cucumber.rake

@@ -2,7 +2,7 @@ require 'cucumber'
 require 'cucumber/rake/task'
 require 'rake/clean'
 
-CUKE_RESULTS = 'cucumber_results.html'
+CUKE_RESULTS = 'cucumber_results.html'.freeze
 
 CLEAN << CUKE_RESULTS
 

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

@@ -68,6 +68,28 @@ module RevealCK
 
         task.prepare
       end
+
+      context 'with a funky directory name' do
+        let :source_dir do
+          'fun+trouble'
+        end
+
+        it 'creates the files from the file_listing' do
+          task = CopyFilesTask.new(application: Rake::Application.new,
+                                   file_listing: file_listing,
+                                   output_dir: destination_directory)
+
+          expect(task)
+            .to receive(:copy_file)
+            .with(file_a_source, file_a_destination)
+
+          expect(task)
+            .to receive(:copy_file)
+            .with(file_b_source, file_b_destination)
+
+          task.prepare
+        end
+      end
     end
   end
 end

data/spec/lib/reveal-ck/commands/serve_ui_spec.rb

@@ -28,15 +28,15 @@ module RevealCK
 
       describe '#problem' do
         it 'prints several messages to standard out' do
-          expect(serve_ui).to receive(:puts).with("#{problem_prefix}")
+          expect(serve_ui).to receive(:puts).with(problem_prefix.to_s)
           expect(serve_ui)
             .to receive(:puts)
             .with("#{problem_prefix} Compilation Problem")
-          expect(serve_ui).to receive(:puts).with("#{problem_prefix}")
+          expect(serve_ui).to receive(:puts).with(problem_prefix.to_s)
           expect(serve_ui)
             .to receive(:puts)
             .with("#{problem_prefix} on line 12")
-          expect(serve_ui).to receive(:puts).with("#{problem_prefix}")
+          expect(serve_ui).to receive(:puts).with(problem_prefix.to_s)
           serve_ui.problem('Compilation Problem', 'on line 12')
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reveal-ck
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Jed Northridge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2016-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -585,7 +585,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Create reveal.js presentations with Markdown.