magic_reveal 2.4.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d5c1f685fc06356224773be6c761b559d20dcb7
+  data.tar.gz: f6061b79e83be0baf5637ee4957045881c3bf3cf
+SHA512:
+  metadata.gz: e638920d89ab90ffcea767da5676b43c77954a93ee68bd42ad3ff86ff501319a91b60ca693e37e7b3ae9cac918d9f40d7b4e02e01c532eb0527a92bc1a921a2f
+  data.tar.gz: 4ba1e2768b60d18b3a54ad24cc8ab858ba4db57d210a61f039c78a46de6d2c527d94e90403a7e27a16a41c466952a12e684ffe657a92488a16d0ae3679f6f5ac

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in magic-reveal.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, :cli => "--color --order default --format progress" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christian Höltje
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# Magic Reveal
+
+Magic Reveal makes creating presentations easy and fun.
+
+See it in action at the [demo/tutorial](http://docwhat.github.io/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)
+
+## Installation
+
+Use `gem` to install magic_reveal:
+
+    $ gem install magic_reveal
+
+The version numbers are the based on the versions of
+[reveal.js](https://github.com/hakimel/reveal.js). The last number is
+the revision specific to Magic Reveal.
+
+### Requirements
+
+* Ruby 1.9.2 or newer
+* A recent version of [Bundler](http://bundler.io/)
+
+<br/>
+Magic Reveal *may* work on non-posix systems, but I make no promises. Pull Requests are
+welcome.
+
+## Usage
+
+To get started:
+
+    $ magic-reveal new my-presentation
+    $ cd my-presentation
+    $ vim slides.md
+
+Feel free to replace [vim](http://vim.org/) with the editor of your choice.
+
+### Viewing the presentation
+
+    $ rackup
+
+Then open your browser to [`http://localhost:9292`](http://localhost:9292).
+
+### The format of slides.md
+
+Magic Reveal uses [github-flavored
+markdown](https://help.github.com/articles/github-flavored-markdown)
+as much as practical.
+
+#### External code files
+
+If you want your source code to be in files outside your `slides.md`, no problem!
+
+To load source from `example.rb`, for example, then use `@@source = <filename>`
+as the body of the code section.
+
+For example:
+
+```
+`@@source = example.rb`
+```
+
+This works with triple back-quote blocks and four-space indented blocks sections as well.
+
+## Development
+
+There is a full [RSpec](http://rspec.info/) test suite.  Make sure you
+write tests before you continue.
+
+For the places where I don't have tests because I couldn't figure it out,
+please help!
+
+### Future plans
+
+* Generate static sites via the `magic-reveal` command line tool
+* A configuration file, for using plugins, etc.
+
+## Contributing
+
+(because you know it could be better)
+
+1. [Fork it](https://github.com/docwhat/magic_reveal)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+namespace :gem do
+  require "bundler/gem_tasks"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+

data/bin/magic-reveal

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'magic_reveal/cli'
+
+MagicReveal::Cli.run

data/lib/magic_reveal/app.rb

@@ -0,0 +1,50 @@
+require 'redcarpet'
+require 'sinatra/base'
+require 'magic_reveal/slide_renderer'
+require 'magic_reveal/index_libber'
+
+begin
+  require 'better_errors'
+  HAS_BETTER_ERRORS = true
+rescue LoadError
+  HAS_BETTER_ERRORS = false
+end
+
+module MagicReveal
+  class App < Sinatra::Base
+    if HAS_BETTER_ERRORS
+      configure :development do
+        use BetterErrors::Middleware
+        BetterErrors.application_root = File.expand_path('../../..', __FILE__)
+      end
+    end
+
+    set :public_folder, File.expand_path('reveal.js', Dir.getwd)
+
+    helpers do
+      def markdown
+        @markdown ||= Redcarpet::Markdown.new(
+          MagicReveal::SlideRenderer.new,
+          :space_after_headers => true,
+          :filter_html => true,
+          :fenced_code_blocks => true,
+          :no_intra_emphasis => true,
+        )
+      end
+
+      def index_html_path
+        @index_html_path ||= Pathname.pwd + 'reveal.js' + 'index.html'
+      end
+    end
+
+    get '/' do
+      slides = markdown.render File.read('slides.md')
+      libber = MagicReveal::IndexLibber.new index_html_path.read
+      libber.update_author       MagicReveal::Identifier.name
+      libber.update_description  "A Magical Presentiation"
+      libber.update_slides       slides
+      libber.to_s
+    end
+
+  end
+end

data/lib/magic_reveal/cli/options.rb

@@ -0,0 +1,30 @@
+module MagicReveal
+  class Cli
+    class Options
+      attr_accessor(
+        :command,
+        :project,
+      )
+
+      def program_name
+        @program_name ||= File.basename($0)
+      end
+
+      def parse args
+        case args.first
+        when 'new'
+          if args.length != 2
+            @command = :help
+          else
+            @command = :new
+            @project = args[1]
+          end
+        when 'help'
+          @command = :help
+        else
+          @command = :help
+        end
+      end
+    end
+  end
+end

data/lib/magic_reveal/cli.rb

@@ -0,0 +1,43 @@
+require 'forwardable'
+
+require 'magic_reveal/cli/options'
+require 'magic_reveal/creator'
+
+module MagicReveal
+  class Cli
+    extend Forwardable
+
+    def_delegator :options, :program_name
+    def_delegator :options, :command
+    def_delegator :options, :project
+
+    attr_writer :creator
+
+    # Helper method
+    def self.run args=ARGV
+      self.new.run args
+    end
+
+    # Action Classes
+    def creator
+      @creator ||= Creator.new(Dir.getwd)
+    end
+
+    def options
+      @options ||= Options.new
+    end
+
+    def run args=ARGV
+      options.parse args
+
+      case command
+      when :new
+        creator.create_project(project)
+      else
+        puts "Usage: #{program_name}"
+        puts
+        puts "This isn't written yet."
+      end
+    end
+  end
+end

data/lib/magic_reveal/conductor.rb

@@ -0,0 +1,51 @@
+require 'magic_reveal'
+require 'net/https'
+require 'archive/zip'
+require 'pathname'
+require 'fileutils'
+
+module MagicReveal
+  # Fetchs a github zip file and unpacks it for use.
+  class Conductor
+    attr_reader :url, :enable_warnings
+
+    def initialize url=nil
+      self.url = url unless url.nil?
+    end
+
+    def url= url
+      @url = URI.parse url
+    end
+
+    def fetch save_path, limit = 5
+      raise TooManyRedirects if limit <= 0
+      save_path = Pathname.new save_path
+
+      request = Net::HTTP::Get.new url.path
+      response = Net::HTTP.start(url.host, url.port, use_ssl: url.scheme == 'https') { |http| http.request(request)  }
+
+      case response
+      when Net::HTTPSuccess then
+        save_path.open('w') { |fp| fp.write response.body }
+      when Net::HTTPRedirection then
+        self.url = response['location']
+        warn "redirected to #{url}" if enable_warnings
+        fetch(save_path, limit - 1)
+      else
+        raise Error, "Huh? #{response.value}"
+      end
+    end
+
+    def unpack zip_file, directory
+      directory = Pathname.new directory
+      raise Error, "Directory '#{directory}' already exists." if directory.exist?
+
+      Archive::Zip.extract zip_file.to_s, directory.to_s
+
+      # Unwrap the outer-most unzipped directory.
+      wrapper_dir = directory.children.first
+      wrapper_dir.children.each { |c| c.rename(directory + c.basename)  }
+      wrapper_dir.rmdir
+    end
+  end
+end

data/lib/magic_reveal/creator.rb

@@ -0,0 +1,49 @@
+require 'fileutils'
+require 'pathname'
+
+require 'magic_reveal/version'
+require 'magic_reveal/reveal_js_fetcher'
+
+module MagicReveal
+  class Creator
+    attr_reader :directory
+    attr_writer :reveal_js_fetcher, :template_slides, :template_config_ru
+
+    def initialize(directory)
+      @directory = Pathname.new directory
+    end
+
+    def reveal_js_fetcher
+      @reveal_js_fetcher ||= RevealJsFetcher.new
+    end
+
+    def template_slides
+      @template_slides ||= Pathname.new(__FILE__).dirname.dirname.dirname + 'README.md'
+    end
+
+    def template_config_ru
+      @template_config_ru ||= Pathname.new(__FILE__).dirname + 'template-config.ru'
+    end
+
+    def create_project(project)
+      top_dir = directory + project
+      reveal_dir = top_dir + 'reveal.js'
+      gemfile = top_dir + 'Gemfile'
+
+      top_dir.mkdir
+
+      reveal_js_fetcher.save_to(reveal_dir)
+      FileUtils.copy_file template_slides.to_s, (top_dir + 'slides.md').to_s
+      FileUtils.copy_file template_config_ru.to_s, (top_dir + 'config.ru').to_s
+      gemfile.open('w') do |f|
+        f.puts "source 'https://rubygems.org'"
+        f.puts
+        f.puts "gem 'magic_reveal', '~> #{VERSION}'"
+      end
+
+      Dir.chdir(top_dir.to_s) do
+        system 'bundle install'
+      end
+    end
+  end
+end

data/lib/magic_reveal/identifier.rb

@@ -0,0 +1,30 @@
+require 'sys/admin'
+
+module MagicReveal
+  class Identifier
+    attr_accessor :sys_admin
+
+    def initialize sys_admin=nil
+      @sys_admin = sys_admin || Sys::Admin
+    end
+
+    # Alias to make life easier.
+    def self.name
+      new.name
+    end
+
+    def name
+      login = sys_admin.get_login
+      user = sys_admin.get_user login
+
+      return user.full_name if user.respond_to? :full_name
+      gecos = user.gecos
+      name = gecos.split(/\s*,\s*/).first
+      if name.nil? || name.empty?
+        return login
+      else
+        return name
+      end
+    end
+  end
+end

data/lib/magic_reveal/index_libber.rb

@@ -0,0 +1,37 @@
+require 'pathname'
+require 'nokogiri'
+require 'magic_reveal/identifier'
+
+module MagicReveal
+  # Mad Libs with Reveal.JS's index.html
+  class IndexLibber
+    attr_reader :html
+
+    def initialize html_text
+      @html = Nokogiri::HTML(html_text, &:noblanks)
+    end
+
+    def update_author author
+      if meta = html.at_xpath("//meta[@name='author']")
+        meta.set_attribute('content', author)
+      end
+    end
+
+    def update_description description
+      if meta = html.at_xpath("//meta[@name='description']")
+        meta.set_attribute('content', description)
+      end
+    end
+
+    def update_slides slides_text
+      slides = Nokogiri::HTML(slides_text).css('section')
+      if container = html.at_css('div.reveal div.slides')
+        container.children = slides
+      end
+    end
+
+    def to_s
+      html.to_html
+    end
+  end
+end

data/lib/magic_reveal/reveal_js_fetcher.rb

@@ -0,0 +1,31 @@
+require 'magic_reveal/version'
+require 'magic_reveal/conductor'
+
+module MagicReveal
+  class RevealJsFetcher
+    attr_reader :version
+    attr_writer :conductor
+
+    def initialize(version=REVEAL_JS_VERSION)
+      @version = version
+    end
+
+    def zip_url
+      "https://github.com/hakimel/reveal.js/archive/#{@version}.zip"
+    end
+
+    def conductor
+      @conductor ||= Conductor.new zip_url
+    end
+
+    def save_to(reveal_dir)
+      reveal_dir = Pathname.new reveal_dir
+
+      Dir.mktmpdir do |tmpdir|
+        zipfile = tmpdir + "fetching-#{REVEAL_JS_VERSION}.zip"
+        conductor.fetch(zipfile)
+        conductor.unpack(zipfile, reveal_dir)
+      end
+    end
+  end
+end

data/lib/magic_reveal/slide_renderer.rb

@@ -0,0 +1,59 @@
+require 'redcarpet'
+require 'cgi'
+
+require 'magic_reveal/version'
+
+module MagicReveal
+  class SlideRenderer < Redcarpet::Render::HTML
+    include Redcarpet::Render::SmartyPants
+    attr_accessor :has_shown_slides
+
+    def initialize
+      super(no_styles: true)
+    end
+
+    def doc_header
+      @has_shown_slides = false
+      "<!-- generated by magic_reveal v#{VERSION} on #{Time.now} -->"
+    end
+
+    def doc_footer
+      has_shown_slides ? '</section>' : ''
+    end
+
+    def header(text, header_level)
+      output = []
+      if has_shown_slides
+        output << "</section>"
+      else
+        @has_shown_slides = true
+      end
+      output << "<section>"
+      output << "<h#{header_level}>#{text}</h#{header_level}>"
+      output.join("\n")
+    end
+
+    def prepare_code(code)
+      if code =~ %r{\A\s*@@source\s*=\s*(.*)\s*\Z}
+        File.read($1)
+      else
+        code
+      end
+    end
+
+    def block_code(code, language)
+      output = []
+      if language
+        output << "<pre class=\"#{language}\">"
+      else
+        output << "<pre>"
+      end
+      output << "<code>"
+
+      output << CGI::escapeHTML(prepare_code code)
+      output << "</code>"
+      output << "</pre>"
+      output.join("")
+    end
+  end
+end

data/lib/magic_reveal/template-config.ru

@@ -0,0 +1,2 @@
+require 'magic_reveal/app'
+run MagicReveal::App

data/lib/magic_reveal/version.rb

@@ -0,0 +1,4 @@
+module MagicReveal
+  REVEAL_JS_VERSION = "2.4.0"
+  VERSION = "#{REVEAL_JS_VERSION}.1"
+end

data/lib/magic_reveal.rb

@@ -0,0 +1,7 @@
+require "magic_reveal/version"
+
+module MagicReveal
+  class Error < StandardError; end
+  class TooManyRedirects < Error; end
+  # Your code goes here...
+end

data/magic-reveal.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magic_reveal/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = "magic_reveal"
+  spec.version               = MagicReveal::VERSION
+  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.files                 = `git ls-files`.split($/)
+  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.required_ruby_version = '>= 1.9.2'
+
+  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_development_dependency "bundler",     "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard-rspec", "~> 3.0"
+  spec.add_development_dependency "rspec",       "~> 2.14"
+  spec.add_development_dependency "coveralls",   "~> 0.6"
+  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
+  spec.add_development_dependency 'terminal-notifier-guard'
+  spec.add_development_dependency 'libnotify'
+end

data/spec/magic_reveal/app_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'magic_reveal/app'
+
+describe MagicReveal::App do
+  # I'm not sure how to test this...
+end

data/spec/magic_reveal/cli/options_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'magic_reveal/cli/options'
+
+describe MagicReveal::Cli::Options do
+  describe ".parse" do
+    before { subject.parse args }
+
+    context "given 'new <project>'" do
+      let(:args) { %w{new someproject} }
+
+      its(:command) { should be(:new) }
+      its(:project) { should eq('someproject') }
+    end
+
+    context "given 'new <project> extrajunk'" do
+      let(:args) { %w{new someproject extrajunk} }
+
+      its(:command) { should be(:help) }
+      its(:project) { should be_nil }
+    end
+
+    context "given 'help'" do
+      let(:args) { %w{help} }
+
+      its(:command) { should be(:help) }
+    end
+
+    context "given no arguments" do
+      let(:args) { [] }
+
+      its(:command) { should be(:help) }
+    end
+  end
+end