magic_reveal 2.6.1.2 → 2.6.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84bff9a97794cc7df8f37262cfa3c4e562917320
-  data.tar.gz: 01bcd7986cd6e692917ac59f308e5dd0e30b37a5
+  metadata.gz: 1d26848d4efe7ddf18d1f06cf7466b705c990b33
+  data.tar.gz: eb2219d4d227d87c2f6031541cd953e029c7c8f7
 SHA512:
-  metadata.gz: 688c0c2e4dbe2d9c404c17dcceefbbc77e92d284f1ba6eae3b8a4a030aa4b5c40ff16e96448ac4780b64b15eb722844f4ad948ceccc34ac30cf5f831d5599ace
-  data.tar.gz: cfd91567e69b6e99de808966bd53202e93c7e94c1e166f73fcabcff4ddd246eee8d168d75b8e1f02e2d1aa971581143fa969505e3dcdb65f435eae4bff034a6f
+  metadata.gz: 285e3207220eef9ed03e789b96fbd2eaccabb9b4f16d1f5e2348a6233c82f3bf0ed11c009f62f95239895d61081d5848b4f5914ab8f5ef8625717dd5327c3b72
+  data.tar.gz: dd484b481a9a8834a9f538719c1581dc0ce057c9f858a0532ef7b171db569678d19056bb977926503e8d290f1a61c4776a164e9ce230a84e9cbd767d1f6c218f

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 1.9.2
   - 2.0.0
+  - 2.1.1

data/Guardfile

@@ -1,5 +1,20 @@
-guard :rspec, :cli => "--color --order default --format doc" do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+group :red_green_refactor, halt_on_fail: true do
+  guard(
+    :rspec,
+    cmd: 'bundle exec rspec --color --order default --format doc',
+    failed_mode: :none,
+    all_on_start: true,
+    all_after_pass: true,
+    run_all: { cmd: 'bundle exec rspec --color --order random --format progress'  }
+  ) do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { 'spec' }
+    watch(%r{^spec/integration/.+_spec\.rb$}) { 'spec' }
+  end
+
+  guard :rubocop, cli: 'lib spec -D', all_on_start: true do
+    watch(%r{^(lib|spec)/.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end

data/README.md

@@ -4,9 +4,11 @@ Magic Reveal makes creating presentations easy and fun.
 
 See it in action at the [demo/tutorial](http://docwhat.github.io/magic_reveal/)
 
+[![Gem Version](https://badge.fury.io/rb/magic_reveal.png)](http://badge.fury.io/rb/magic_reveal)
 [![Build Status](https://secure.travis-ci.org/docwhat/magic_reveal.png?branch=master)](http://travis-ci.org/docwhat/magic_reveal)
 [![Dependencies](https://gemnasium.com/docwhat/magic_reveal.png?branch=master)](https://gemnasium.com/docwhat/magic_reveal)
 [![Coverage Status](https://coveralls.io/repos/docwhat/magic_reveal/badge.png?branch=master)](https://coveralls.io/r/docwhat/magic_reveal)
+[![Code Climate](https://codeclimate.com/github/docwhat/magic_reveal.png)](https://codeclimate.com/github/docwhat/magic_reveal)
 
 ## Installation
 
@@ -20,7 +22,7 @@ the revision specific to Magic Reveal.
 
 ### Requirements
 
-* Ruby 1.9.2 or newer
+* Ruby 1.9.3 or newer
 * A recent version of [Bundler](http://bundler.io/)
 
 <br/>

data/bin/magic-reveal

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'magic_reveal/cli'
 

data/lib/magic_reveal.rb

@@ -1,4 +1,4 @@
-require "magic_reveal/version"
+require 'magic_reveal/version'
 
 module MagicReveal
   class Error < StandardError; end

data/lib/magic_reveal/app.rb

@@ -12,6 +12,7 @@ rescue LoadError
 end
 
 module MagicReveal
+  # The web application
   class App < Sinatra::Base
     if HAS_BETTER_ERRORS
       configure :development do
@@ -41,6 +42,5 @@ module MagicReveal
       config = ProjectConfig.new(Pathname.pwd + 'config.json')
       config.to_js
     end
-
   end
 end

data/lib/magic_reveal/cli.rb

@@ -8,6 +8,7 @@ require 'magic_reveal/index_libber'
 require 'magic_reveal/project_config'
 
 module MagicReveal
+  # Command line interface
   class Cli
     extend Forwardable
 
@@ -18,26 +19,28 @@ module MagicReveal
     attr_writer :creator
 
     # Helper method
-    def self.run args=ARGV
-      self.new.run args
+    def self.run(args = ARGV)
+      new.run args
     end
 
     # Action Classes
-    def show_help
-      puts "Usage: #{program_name} <command>"
-      puts
-      puts '  new <name>'
-      puts '    Creates new presentation in directory <name>'
-      puts
-      puts '  force-reload'
-      puts '    Refreshes the reveal.js files. WARNING: This may override customizations!'
-      puts
-      puts '  start [options]'
-      puts '    Starts serving the presentation in the current directory'
-      puts
-      puts '  static'
-      puts '    Creates a static index.html file from your slides'
-      puts
+    def show_help # rubocop:disable MethodLength
+      puts <<-EOF
+Usage: #{program_name} <command>
+  Magic reveal version: #{MagicReveal::VERSION}
+
+  new <name>
+    Creates new presentation in directory <name>
+
+  force-reload
+    Refreshes the reveal.js files. WARNING: This may override customizations!
+
+  start [options]
+    Starts serving the presentation in the current directory
+
+  static
+    Creates a static index.html file from your slides
+      EOF
       exit
     end
 
@@ -52,7 +55,7 @@ module MagicReveal
       exit
     end
 
-    def create_static
+    def create_static # rubocop:disable MethodLength
       slides = Pathname.pwd + 'slides.md'
       markdown =  SlideRenderer.markdown_renderer
       libber = IndexLibber.new
@@ -71,8 +74,8 @@ module MagicReveal
     end
 
     def avenge_programmer
-      puts "The programmer messed up."
-      puts "Please file a bug at https://github.com/docwhat/magic_reveal"
+      puts 'The programmer messed up.'
+      puts 'Please file a bug at https://github.com/docwhat/magic_reveal'
       exit 13
     end
 
@@ -80,14 +83,14 @@ module MagicReveal
       @options ||= Options.new
     end
 
-    def run args=ARGV
+    def run(args = ARGV) # rubocop:disable MethodLength, CyclomaticComplexity
       options.parse args
 
       case command
       when :new
         creator.create_project(project)
       when :force_reload
-        theyre_sure = (ask('This may overwrite customizations. Are you sure? (y/N) ') { |q| q.limit = 1; q.case = :downcase }) == 'y'
+        theyre_sure = (ask('This may overwrite customizations. Are you sure? (y/N) ') { |q| q.limit = 1; q.case = :downcase }) == 'y' # rubocop:disable Semicolon
         creator.update_project(Dir.getwd) if theyre_sure
       when :start
         start_server

data/lib/magic_reveal/cli/options.rb

@@ -1,16 +1,17 @@
 module MagicReveal
   class Cli
+    # Command line options
     class Options
       attr_accessor(
         :command,
-        :project,
+        :project
       )
 
       def program_name
-        @program_name ||= File.basename($0)
+        @program_name ||= File.basename($PROGRAM_NAME)
       end
 
-      def parse args
+      def parse(args) # rubocop:disable MethodLength
         case args.first
         when 'new'
           if args.length != 2

data/lib/magic_reveal/conductor.rb

@@ -9,16 +9,16 @@ module MagicReveal
   class Conductor
     attr_reader :url, :enable_warnings
 
-    def initialize url=nil
+    def initialize(url = nil)
       self.url = url unless url.nil?
     end
 
-    def url= url
+    def url=(url)
       @url = URI.parse url
     end
 
-    def fetch save_path, limit = 5
-      raise TooManyRedirects if limit <= 0
+    def fetch(save_path, limit = 5) # rubocop:disable MethodLength
+      fail TooManyRedirects if limit <= 0
       save_path = Pathname.new save_path
 
       request = Net::HTTP::Get.new url.path
@@ -32,13 +32,13 @@ module MagicReveal
         warn "redirected to #{url}" if enable_warnings
         fetch(save_path, limit - 1)
       else
-        raise Error, "Huh? #{response.value}"
+        fail Error, "Huh? #{response.value}"
       end
     end
 
-    def unpack zip_file, directory
+    def unpack(zip_file, directory)
       directory = Pathname.new directory
-      raise Error, "Directory '#{directory}' already exists." if directory.exist?
+      fail Error, "Directory '#{directory}' already exists." if directory.exist?
 
       Archive::Zip.extract zip_file.to_s, directory.to_s
 

data/lib/magic_reveal/creator.rb

@@ -6,6 +6,7 @@ require 'magic_reveal/reveal_js_fetcher'
 require 'magic_reveal/project_config'
 
 module MagicReveal
+  # Creates the world!
   class Creator
     attr_reader :directory
     attr_writer :reveal_js_fetcher, :template_slides, :template_config_ru
@@ -32,7 +33,7 @@ module MagicReveal
       reveal_js_fetcher.save_important_parts_to(top_dir)
     end
 
-    def create_project(project)
+    def create_project(project) # rubocop:disable MethodLength
       top_dir = directory + project
       gemfile = top_dir + 'Gemfile'
 

data/lib/magic_reveal/identifier.rb

@@ -1,10 +1,11 @@
 require 'sys/admin'
 
 module MagicReveal
+  # figures out the author's identity
   class Identifier
     attr_accessor :sys_admin
 
-    def initialize sys_admin=nil
+    def initialize(sys_admin = nil)
       @sys_admin = sys_admin || Sys::Admin
     end
 

data/lib/magic_reveal/index_libber.rb

@@ -7,20 +7,20 @@ module MagicReveal
   class IndexLibber
     attr_reader :html
 
-    def initialize html_text=nil
+    def initialize(html_text = nil)
       if html_text.nil?
         template_path = Pathname.new(__FILE__).dirname + 'template.html'
         html_text = template_path.read
       end
       @html = Nokogiri::HTML(html_text, &:noblanks)
       # Add autogenerated comment
-      #html.children.first.add_previous_sibling(Nokogiri::XML::Comment.new("Generated at #{Time.now}"))
+      # html.children.first.add_previous_sibling(Nokogiri::XML::Comment.new("Generated at #{Time.now}"))
       html.root.children.first.before Nokogiri::XML::Comment.new(html, "Generated at #{Time.now}")
     end
 
-    def set_meta name, content
+    def set_meta(name, content)
       meta = html.at_css("meta[@name='#{name}']")
-      if !meta
+      unless meta
         meta = Nokogiri::XML::Node.new('meta', html)
         meta[:name]    = name
 
@@ -30,22 +30,22 @@ module MagicReveal
       meta[:content] = content
     end
 
-    def title= title
+    def title=(title)
       html.title = title
     end
 
-    def author= author
+    def author=(author)
       set_meta 'author', author
     end
 
-    def description= description
+    def description=(description)
       set_meta 'description', description
     end
 
-    def theme= theme
+    def theme=(theme)
       # <link rel="stylesheet" href="css/theme/default.css" id="theme">
-      node = html.at_css("link#theme")
-      if !node
+      node = html.at_css('link#theme')
+      unless node
         node = Nokogiri::XML::Node.new('link', html)
         node[:id]   = 'theme'
         node[:rel]  = 'stylesheet'
@@ -56,7 +56,7 @@ module MagicReveal
       node[:href] = "css/theme/#{theme}.css"
     end
 
-    def slides= text
+    def slides=(text)
       slides = Nokogiri::HTML.fragment(text).children
       container = html.at_css('div.reveal div.slides')
       container.children = slides
@@ -64,21 +64,30 @@ module MagicReveal
       self.title = headers.first.text unless headers.nil? || headers.empty?
     end
 
-    def add_github_forkme project
-      a = Nokogiri::XML::Node.new('a', html)
-      a[:class] = 'fork-me'
-      a[:style] = 'display: none;'
-      a[:href] = "https://github.com/#{project}"
-      img = Nokogiri::XML::Node.new('img', html)
-      img[:style] = "position: absolute; top: 0; right: 0; border: 0;"
-      img[:src]="https://a248.e.akamai.net/camo.github.com/e6bef7a091f5f3138b8cd40bc3e114258dd68ddf/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67"
-      img[:alt] = "Fork me on GitHub"
+    def github_banner_img
+      Nokogiri::XML::Node.new('img', html).tap do |img|
+        img[:style] = 'position: absolute; top: 0; right: 0; border: 0;'
+        img[:src] = 'https://a248.e.akamai.net/camo.github.com/e6bef7a091f5f3138b8cd40bc3e114258dd68ddf/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67'
+        img[:alt] = 'Fork me on GitHub'
+      end
+    end
+
+    def github_fork_link(project)
+      Nokogiri::XML::Node.new('a', html).tap do |a|
+        a[:class] = 'fork-me'
+        a[:style] = 'display: none;'
+        a[:href] = "https://github.com/#{project}"
+      end
+    end
+
+    def add_github_forkme(project)
+      a = github_fork_link project
       script = Nokogiri::XML::Node.new('script', html)
       script.content = "if( !navigator.userAgent.match( /iphone|ipod|android|ipad|blackberry/gi  ) && !!document.querySelector  ) { document.querySelector('.fork-me' ).style.display = 'block'; }"
 
       parent = (body = html.at('body')) ? body : html.root
       parent << a
-      a << img
+      a << github_banner_img
       parent << script
     end
 

data/lib/magic_reveal/project_config.rb

@@ -2,13 +2,20 @@ require 'pathname'
 require 'json'
 
 module MagicReveal
+  # A Project's configuration
   class ProjectConfig
     DEFAULT_TEMPLATE = File.expand_path('../template-config.json', __FILE__)
+    DEPENDENCY_ENABLER_JS = {
+      'highlight' => '{ src: "plugin/highlight/highlight.js", async: true, callback: function() { hljs.initHighlightingOnLoad(); } }',
+      'zoom'      => '{ src: "plugin/zoom-js/zoom.js", async: true, condition: function() { return !!document.body.classList; } }',
+      'notes'     => '{ src: "plugin/notes/notes.js", async: true, condition: function() { return !!document.body.classList; } }'
+    }
+
     attr_reader :json
 
-    def initialize io_or_path
+    def initialize(io_or_path)
       io = io_or_path.respond_to?(:read) ? io_or_path : Pathname.new(io_or_path)
-      @json = JSON::load(io.read)
+      @json = JSON.load(io.read)
     end
 
     def dependencies
@@ -16,22 +23,16 @@ module MagicReveal
       # you always want this
       out << '{ src: "lib/js/classList.js", condition: function() { return !document.body.classList; } }'
 
-      if json['plugins'].include? 'highlight'
-        out << '{ src: "plugin/highlight/highlight.js", async: true, callback: function() { hljs.initHighlightingOnLoad(); } }'
-      end
-      if json['plugins'].include? 'zoom'
-        out << '{ src: "plugin/zoom-js/zoom.js", async: true, condition: function() { return !!document.body.classList; } }'
-      end
-      if json['plugins'].include? 'notes'
-        out << '{ src: "plugin/notes/notes.js", async: true, condition: function() { return !!document.body.classList; } }'
+      DEPENDENCY_ENABLER_JS.keys.each do |plugin|
+        out << DEPENDENCY_ENABLER_JS[plugin] if json['plugins'].include?(plugin)
       end
 
       "\"dependencies\": [\n#{out.join(",\n")}\n]"
     end
 
-    def to_js
+    def to_js # rubocop:disable MethodLength
       var = []
-      keys = json.keys.reject { |k| ['dependencies', 'github'].include?(k) }
+      keys = json.keys.reject { |k| %w{ 'dependencies', 'github' }.include?(k) }
       keys.each do |key|
         value = json[key]
         var << "  #{key}: #{value.to_json}"
@@ -39,10 +40,10 @@ module MagicReveal
 
       out = []
       out << "/* Generated at #{Time.now} */"
-      out << "var config = {"
+      out << 'var config = {'
       out << "#{var.join(",\n")},\n#{dependencies}"
       out << "\n};"
-      out << "Reveal.initialize(config);"
+      out << 'Reveal.initialize(config);'
       out.join("\n")
     end
   end

data/lib/magic_reveal/reveal_js_fetcher.rb

@@ -3,11 +3,12 @@ require 'magic_reveal/version'
 require 'magic_reveal/conductor'
 
 module MagicReveal
+  # Fetches Reveal.js
   class RevealJsFetcher
     attr_reader :version
     attr_writer :conductor
 
-    def initialize(version=REVEAL_JS_VERSION)
+    def initialize(version = REVEAL_JS_VERSION)
       @version = version
     end
 
@@ -36,7 +37,7 @@ module MagicReveal
       Dir.mktmpdir do |tmpdir|
         tmp_reveal_dir = Pathname(tmpdir) + 'reveal.js'
         save_to(tmp_reveal_dir.to_s)
-        tmp_reveal_dir.children.select(&:directory?).reject{|c| %w[test].include? c.basename.to_s}.each do |dir|
+        tmp_reveal_dir.children.select(&:directory?).reject { |c| %w[test].include? c.basename.to_s }.each do |dir|
           FileUtils.cp_r(dir.to_s, reveal_dir.to_s)
         end
       end