slidemgr 1.0.1

data/README.md

@@ -0,0 +1,153 @@
+# slidemgr
+A little commandline program to generate and manage reveal.js slides. Checkout 
+(https://github.com/hakimel/reveal.js/)[reveal.js].It's pretty cool.
+
+## Installation
+You need Ruby installed in order to use slidemgr. I tested it with 2.2, but I
+guess it is compatible with older releases as well.
+Take a look at https://www.ruby-lang.org/en/documentation/installation/
+to install ruby.
+After that, fire up a terminal and type in:
+```bash
+gem install slidemgr
+```
+You can now use slidemgr.
+## Usage
+slidemgr is a commandline program. Open a terminal and type in `slidemgr`
+to get a list of options.
+
+### Initialize a new project
+
+The first thing you want to do is initializing a new project. A project can contain
+multiple cohesive presentations. I'll do an example for a lecture called *programming*.
+The command for initializing a project is `init`:
+
+```bash
+slidemgr init
+```
+
+slidemgr will ask you a view questions about your project. In order to synchronize
+your master-presentation with the audience, you need a token/secret pair. Thus 
+slidemgr will ask you for Socket.io-host. reveal.js offers a public server at
+http://revealjs.jit.su/ , so you can use this one if you like.
+
+You can skip the interactive process by passing the required information to slidemgr:
+```bash
+slidemgr init programming --host revealjs.jit.su --git git@github.com/path/to/repo
+```
+After the initialization you can see that slidemgr creates a new directory 
+containing your project. Now change into the project-directory. 
+```bash
+cd programming
+```
+All following commands need you to be within the project-directory-structure.
+Let's take a look what happened.
+```bash
+ls
+# output
+client  config.yml  master
+```
+Both master and clientfolder contain a minimal installation of reveal.js. The
+idea is simple. You present the master-slides to your audience. The audience 
+should get served client-slides to their own devices.
+The key strength of slidemgr is the synchrinization between master-slides and
+client-slides, so you can easily make changes without the hassle of doing a
+manual sync. The file `config.yml` is intended for project-wide meta information.
+You can change your initial settings here if you want.
+
+**Beware**
+
+Do not rename or remove the config.yml file. You shouldn't move around files that are outside
+the content-folder either.
+
+### Create a new presentation
+To create a new presentation use the command `create`:
+```bash
+slidemgr create hello_world 
+```
+this will create both a new master-presentation, as well as a client-presentation.
+
+To alter the content of your newly generated presentation, change the file within
+`master/slides/YOUR_PRESENTATION_NAME/content/content.md`
+
+The content is written in [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). 
+To seperate slides, use the following:
+
+| --  | vertical slide   |
+|-----|------------------|
+| --- | horizontal slide |
+
+```markdown
+## Hello World
+
+--
+
+Tradition demands, that the first program should print "Hello World!"
+
+---
+
+## Java
+
+--
+
+![an image](content/image.png)
+```
+
+If you want to place an image, it's easiest to store them within the content-directory.
+After that reference the image like in the example above.
+
+
+### Synchronize your work
+
+After adding some content to your new presentation, you need to sync it with the client.
+Use the `sync` command:
+
+```bash
+slidemgr sync
+```
+
+this syncs all your presentations. If you only want to sync a particular presentation,
+give the name of the presentation as an argument:
+
+```bash
+slidemgr sync hello_world
+```
+The synchronization will copy all content from the master-slides to client-slides.
+If you have a git-repository, it will also commit your changes and push them to the remote-repository (if present).
+
+### Start your presentation
+Slidemgr has a built-in webserver to start your presentation. Use the `start` command.
+```bash
+slidemgr start
+```
+It will start the webserver and open your default-browser. If you specify a presentation as
+a parameter, it will automatically navigate to the presentation.
+To stop the server, switch back to your terminal where you started the server and press CTRL+C.
+
+### Other commands
+
+Slidemgr comes with a view more commands. Use the builtin help to see their usage.
+
+## Copyright
+### slidemgr
+Copyright (c) 2015 Rene Richter
+slidemgr is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software Foundation,
+Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
+
+
+### reveal.js
+MIT licensed
+
+Copyright (C) 2015 Hakim El Hattab, http://hakim.se
+
+
+

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/slidemgr

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'command_router'
+require 'thor'
+
+
+CommandRouter::Main.start ARGV
+
+

data/lib/command_router.rb

@@ -0,0 +1,27 @@
+require 'commands/create'
+require 'commands/init'
+require 'commands/sync'
+require 'commands/start'
+require 'commands/refresh'
+require 'commands/rename'
+require 'commands/remove'
+require 'commands/list'
+require 'thor'
+
+module CommandRouter
+  include Util
+
+  class Main < Thor
+
+    register(Init, 'init', 'init [project_name]', 'Initializes a new project.')
+    register(Create, 'create', 'create [presentation_name]', 'Creates a new presentation')
+    register(Sync, 'sync', 'sync [name]', 'syncs master and client.')
+    register(Start,'start','start [presentation_name]','starts a presentation-server.')
+    register(Refresh,'refresh','refresh [presentation_name]','refreshes the token')
+    register(Remove,'remove','remove [presentation_name]', 'removes a presentation')
+    register(Rename,'rename','rename [old_name] [new_name]', 'renames a presentation')
+    register(List,'list','list','lists all presentations.')
+
+  end
+
+end

data/lib/commands/create.rb

@@ -0,0 +1,61 @@
+require 'thor'
+require 'thor/group'
+require 'pathname'
+require 'util'
+require 'nokogiri'
+require 'net/http'
+require 'json'
+require 'yaml'
+
+
+class Create < Thor::Group
+  include Thor::Actions
+  include Util
+
+  argument :name, :type => :string, :desc => 'The presentation name'
+
+  def self.source_root
+    File.expand_path('../',__dir__)
+  end
+
+  def prepare_parameters
+    @snake_case_name = @name.sub ' ','_'
+  end
+
+
+  def create_master
+    @config = parse_config
+    @token = request_token
+    @client = false
+    template 'template/index.erb',
+             "#{content_root}/master/slides/#{@snake_case_name}/index.html"
+
+    template 'template/content.md.erb',
+             "#{content_root}/master/slides/" \
+             "#{@snake_case_name}/content/content.md"
+  end
+
+  def create_client
+    @client = true
+    template 'template/index.erb',
+             "#{content_root}/client/slides/#{@snake_case_name}/index.html"
+  end
+
+  def append_index
+    index = "#{content_root}/client/index.html"
+    template 'template/overview_index.erb',index unless File.exist?(index)
+
+    alter_index_html do | doc |
+      unless doc.xpath('//a').map(&:content).include? @name
+        body = doc.at_css 'body'
+        h2 = Nokogiri::XML::Node.new 'h2', doc
+        link = Nokogiri::XML::Node.new 'a', doc
+        link['href'] = "slides/#{@snake_case_name}/"
+        link.content= "#{@name}"
+        h2 << link
+        body << h2
+      end
+    end
+  end
+
+end

data/lib/commands/init.rb

@@ -0,0 +1,78 @@
+require 'thor'
+require 'thor/group'
+require 'fileutils'
+require 'uri'
+require 'util'
+
+class Init < Thor::Group
+  include Thor::Actions
+  include Util
+
+  def self.source_root
+    File.expand_path('../',__dir__)
+  end
+
+  argument :project_name,
+           :type => :string,
+           :desc => 'The project name',
+           :required => false
+
+
+  class_option :host,
+               :type => :string,
+               :desc => 'host-server'
+
+  class_option :git,
+               :type => :string,
+               :desc => 'initializes a git-repository'
+
+  #TODO download latest reveal-framework. maybe rubyzip. duno
+  def create_project_structure
+
+    @host = options[:host]
+    @git = options[:git]
+
+    interactive_mode unless @host && @project_name
+
+    @url = URI.parse "http://#{@host}"
+
+    empty_directory "#{@project_name}/master/slides"
+    empty_directory "#{@project_name}/client/slides"
+
+    template 'template/config.yml.erb', "#{@project_name}/config.yml"
+    directory 'template/reveal.js-3.0.0/', "#{@project_name}/master/"
+    directory 'template/reveal.js-3.0.0/', "#{@project_name}/client/"
+
+    if @git
+      @git == 'git' ?
+          init_git(@project_name) : init_git(@project_name,@git)
+    end
+  end
+
+  no_commands do
+    def interactive_mode
+      say("so it seems that you didn't bother to give me some input. Fine. I'll ask")
+      @project_name = @project_name || ask('Whats the name of the project?')
+
+      abort('You need to specify a project name. Try again') if @project_name.empty?
+
+
+      @host = @host || ask('whats the host of your token-server?(host+port)')
+
+      abort('You need to specify a host.Try again') if @host.empty?
+
+      unless @git
+        if yes?('Do you want to use git?(y,n)')
+          git_answer = ask('specify a remote (leave blank for local repository)')
+          @git =
+              git_answer.empty? ? 'git' : git_answer
+        end
+      end
+
+
+    end
+  end
+
+
+
+end

data/lib/commands/list.rb

@@ -0,0 +1,12 @@
+require 'util'
+require 'thor/group'
+
+class List < Thor::Group
+  include Util
+
+  def list
+    each_presentation do |master,client|
+      puts "#{File.basename(master)}"
+    end
+  end
+end

data/lib/commands/refresh.rb

@@ -0,0 +1,49 @@
+require 'thor/group'
+require 'util'
+
+class Refresh < Thor::Group
+  include Util
+  include Thor::Actions
+
+
+  argument :presentation_name,
+           :type => :string,
+           :desc => 'The presentation name',
+           :required => false
+
+
+  def refresh_presentation
+
+    block = Proc.new do |master,client|
+      say "refreshing tokens and secrets for #{File.basename(master)}"
+      master = "#{master}/index.html"
+      client = "#{client}/index.html"
+      master_content = File.read(master)
+      token = request_token
+      config = parse_config
+      multiplex = %Q( multiplex: {
+            secret: "#{token.secret}",
+            id: "#{token.socket_id}",
+            url: "#{config.host}:#{config.port}"
+        },
+      )
+      regex = /multiplex: \{.*?\},/m
+      master_content.sub!(regex,multiplex)
+      File.write(master, master_content)
+
+      client_content = File.read(client)
+      multiplex = %Q( multiplex: {
+            secret: null,
+            id: "#{token.socket_id}",
+            url: "#{config.host}:#{config.port}"
+        },
+      )
+      client_content.sub!(regex,multiplex)
+      File.write(client, client_content)
+    end
+
+    @presentation_name ?
+      presentation(@presentation_name,&block) : each_presentation(&block)
+  end
+
+end

data/lib/commands/remove.rb

@@ -0,0 +1,32 @@
+require 'thor/group'
+require 'util'
+require 'fileutils'
+
+class Remove < Thor::Group
+  include Thor::Actions
+  include Util
+
+
+  argument :name, :type => :string, :desc => 'The presentation name'
+  class_option :yes, :type => :boolean, :desc => 'do not ask'
+
+
+  def remove_presentation
+
+    presentation @name do |master,client|
+      if @yes.nil?
+        @yes = yes? "do you really want to delete #{File.basename(master)}?(y,N)"
+      end
+
+      if @yes
+        FileUtils.rm_rf master
+        FileUtils.rm_rf client
+      end
+    end
+
+    alter_link(@name) do | link |
+      link.parent.remove
+    end
+
+  end
+end

data/lib/commands/rename.rb

@@ -0,0 +1,31 @@
+require 'util'
+require 'thor/group'
+require 'fileutils'
+require 'nokogiri'
+
+
+class Rename < Thor::Group
+  include Thor::Actions
+  include Util
+
+  argument :old_name, :type => :string, :desc => 'The old name'
+  argument :new_name, :type => :string, :desc => 'The new name'
+
+  def rename
+
+    presentation(@old_name) do |master,client|
+
+      say "renaming #{@old_name} to #{@new_name}..."
+      new_master = "#{content_root}/master/slides/#{@new_name}"
+      new_client = "#{content_root}/client/slides/#{@new_name}"
+      FileUtils.mv master,new_master
+      FileUtils.mv client,new_client
+
+      alter_link(File.basename(master)) do | link |
+        link['href'] = "slides/#{@new_name}/"
+        link.content= "#{@new_name}"
+      end
+    end
+
+  end
+end

data/lib/commands/start.rb

@@ -0,0 +1,36 @@
+require 'thor/group'
+require 'util'
+require 'webrick'
+require 'launchy'
+
+
+class Start < Thor::Group
+  include Util
+
+  class_option :port,
+               :type => :numeric,
+               :desc => "the server-port",
+               :default => 8080
+
+  argument :presentation_name,
+           :type => :string,
+           :desc => 'The name of the presentation',
+           :required => false
+
+  def start
+    root = "#{content_root}/master"
+    thr = Thread.new do
+      server =
+          WEBrick::HTTPServer.new :Port => options[:port], :DocumentRoot => root
+      trap 'INT' do server.shutdown end
+      server.start
+    end
+    if @presentation_name
+      Launchy.open("http://localhost:#{options[:port]}/slides/#{@presentation_name}")
+    else
+      Launchy.open("http://localhost:#{options[:port]}/slides/")
+    end
+    thr.join
+  end
+
+end

data/lib/commands/sync.rb

@@ -0,0 +1,31 @@
+require 'thor'
+require 'thor/group'
+require 'util'
+require 'git'
+
+
+class Sync < Thor::Group
+  include Thor::Actions
+  include Util
+
+  argument :name,
+           :type => :string,
+           :desc => 'The presentation name',
+           :required => false
+
+  def syn
+
+    block = Proc.new do | master,client |
+      puts "syncing content for #{File.basename(master)}"
+      FileUtils.cp_r "#{master}/content/",
+                     "#{client}/content/"
+    end
+
+    @name ? presentation(@name.sub(' ','_'),&block) : each_presentation(&block)
+
+    if git_repository?
+      puts 'syncing wiht git...'
+      add_to_git
+    end
+  end
+end

data/lib/template/config.yml.erb

@@ -0,0 +1,4 @@
+project_name: <%=@project_name%>
+host: <%=@url.host%>
+port:  <%=@url.port%>
+

data/lib/template/content.md.erb

@@ -0,0 +1,2 @@
+## <%= @name %>
+---

data/lib/template/index.erb

@@ -0,0 +1,103 @@
+<!doctype html>
+<html lang="de">
+
+<head>
+  <meta charset="utf-8">
+
+  <title><%="#{@config.project_name} - #{@name}"%></title>
+
+  <meta name="author" content="Rene Richter">
+
+  <meta name="apple-mobile-web-app-capable" content="yes" />
+  <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
+
+  <link rel="stylesheet" href="/css/reveal.css">
+  <link rel="stylesheet" href="/css/theme/black.css" id="theme">
+
+  <!-- Code syntax highlighting -->
+  <link rel="stylesheet" href="/lib/css/zenburn.css">
+
+  <!-- Printing and PDF exports -->
+  <script>
+      var link = document.createElement( 'link' );
+      link.rel = 'stylesheet';
+      link.type = 'text/css';
+      link.href = window.location.search.match( /print-pdf/gi ) ? '/css/print/pdf.css' : '/css/print/paper.css';
+      document.getElementsByTagName( 'head' )[0].appendChild( link );
+
+      function getParameterByName(name) {
+          name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
+          var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
+                  results = regex.exec(location.search);
+          return results === null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
+      }
+      var theme = getParameterByName('theme');
+      if (theme === null || theme === "" || theme === undefined)
+          theme = "black";
+
+      if(theme.substr(-1) == '/')
+          theme = theme.substr(0, theme.length - 1);
+      document.getElementById('theme').setAttribute('href','/css/theme/'+theme+'.css');
+
+  </script>
+
+  <!--[if lt IE 9]>
+  <script src="lib/js/html5shiv.js"></script>
+  <![endif]-->
+</head>
+
+<body>
+
+<div class="reveal">
+  <div class="slides">
+    <section data-markdown="content/content.md"
+             data-separator="^---"
+             data-separator-vertical="^--"
+             data-separator-notes="^Note:"
+             data-charset="utf-8">
+      <section><pre><code class="java"> </code></pre></section>
+    </section>
+  </div>
+
+</div>
+
+<script src="/lib/js/head.min.js"></script>
+<script src="/js/reveal.js"></script>
+
+<script>
+
+    // Full list of configuration options available at:
+    // https://github.com/hakimel/reveal.js#configuration
+    Reveal.initialize({
+        controls: true,
+        progress: true,
+        history: true,
+        center: true,
+
+        multiplex: {
+            secret: <%=@client ? "null" : %Q("#{@token.secret}") %>,
+            id: "<%=@token.socket_id %>",
+            url: "<%="#{@config.host}:#{@config.port}"%>"
+        },
+
+        transition: 'slide', // none/fade/slide/convex/concave/zoom
+
+        // Optional reveal.js plugins
+        dependencies: [
+            { src: '/lib/js/classList.js', condition: function() { return !document.body.classList; } },
+            { src: '/plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
+            { src: '/plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
+            { src: '/plugin/highlight/highlight.js', async: true, condition: function() { return !!document.querySelector( 'pre code' ); }, callback: function() { hljs.initHighlightingOnLoad(); } },
+            { src: '/plugin/zoom-js/zoom.js', async: true },
+            { src: '/plugin/notes/notes.js', async: true },
+            { src: 'http://cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
+            { src:  '/plugin/multiplex/<%=@client ? "client" : "master" %>.js', async: true }
+        ]
+    });
+
+</script>
+
+</body>
+</html>

data/lib/template/overview_index.erb

@@ -0,0 +1,9 @@
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <meta charset="utf-8">
+</head>
+<body>
+<h1><%=@config.project_name%></h1>
+</body>
+</html>