jekyll_reveal_generator 0.2.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d08fa0c08fb27a44a96e0ef462523bd849a6c91f
+  data.tar.gz: ce77550f90689c4ec42a2cf6edf0dbed5cc54499
+SHA512:
+  metadata.gz: '05092d82c726399926066eebdf1977059859889b625805ca4ea43374645d0a2760a1339215ce77c739c684b93d1ed3391b24995f7af45a10f8924908cbc2cb55'
+  data.tar.gz: 9939bfe3445a393611cb69d62e492f3e8866a83318e663b0c03555b4ff5308806a3eab44f013813bfc452b9812e2cb00772e7862dd85f34b6f28eb141e398188

data/.editorconfig

@@ -0,0 +1,23 @@
+# EditorConfig is awesome: http://EditorConfig.org
+# Sample (and default) .editorconfig file for projects
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab
+indent_size = 1
+
+# Matches the exact files either package.json or .travis.yml
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,11 @@
+.byebug-history
+.byebug_history
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/Gemfile

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

data/README.md

@@ -0,0 +1,80 @@
+# JekyllRevealGenerator
+
+Generate Jekyll-Reveal.js Slide Presentations
+
+You should be familiar with [Jekyll] and [Reveal] to use this generator
+effectively.
+
+[Jekyll]: http://jekyllrb.com "The blog-aware static site generator"
+[Reveal]: http://lab.hakim.se/reveal-js/#/ "The HTML presentation framework"
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install jekyll_reveal_generator
+
+## Usage
+
+  	$ jekyll_reveal_generator help
+
+or
+
+    $ jrg help
+
+To create a new presentation, use `init`:
+
+    $ jrg init my_prez
+
+and answer the prompts. This will run the `setup.sh` script and
+initialize a git repository and make the first commit.
+
+To create a slide, from the presentation root directory, run:
+
+    $ cd my_pres
+    $ jrg slide
+
+and answer the prompts.
+
+The included Rakefile has two tasks, `serve` and `publish`:
+
+* `serve` launches the jekyll server on port 4000
+* `publish` builds the presentation adding the `_publish.yml`
+  configuration to the normal configuration
+
+## Templates
+
+The slide presentation template is in the `templates/presentation/`
+directory.
+
+The new slide templates are in `templates/slides`
+
+There is no provision for adding or modifying the templates.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake test` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will
+create a git tag for the version, push git commits and tags, and push
+the `.gem` file to [rubygems.org](https://rubygems.org).
+
+This gem utilizes [Thor] as a generator.
+
+## Testing
+
+Testing is using [RSpec] for unit testing, and [Aruba] for
+command-line testing.
+
+[RSpec]: http://rspec.info/ "Behavior-Driven Development for Ruby. Making TDD Productive and Fun"
+[Aruba]: https://github.com/cucumber/aruba "Test command-line applications with Cucumber-Ruby, Rspec, or Minitest"
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub
+at <https://github.com/tamouse/jekyll_reveal_generator>.

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  require 'cucumber'
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty"
+  end
+
+  task :default => [:spec, :features]
+
+rescue LoadError
+  $stderr.puts "Could not load Cucumber"
+end
+
+task :serve do |t|
+  sh 'bundle exec jekyll serve'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll_reveal_generator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

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

data/bin/thor

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("thor", "thor")

data/exe/jekyll_reveal_generator

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "jekyll_reveal_generator"
+JekyllRevealGenerator::Cli.start

data/exe/jrg

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "jekyll_reveal_generator"
+JekyllRevealGenerator::Cli.start

data/jekyll_reveal_generator.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll_reveal_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll_reveal_generator"
+  spec.version       = JekyllRevealGenerator::VERSION
+  spec.authors       = ["Tamara Temple"]
+  spec.email         = ["tamouse@gmail.com"]
+
+  spec.summary       = %q{Generate Jekyll-Reveal.js Slides}
+  spec.description   = %q{Generate a slide presentation that uses Jekyll and Reveal.js}
+  spec.homepage      = "https://github.com/tamouse/jekyll_reveal_generator"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler"
+  spec.add_dependency "rake"
+  spec.add_dependency "thor"
+  spec.add_dependency "recursive-open-struct"
+
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba", "~> 1.0.0-alpha.2"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "pry-byebug"
+
+end

data/lib/jekyll_reveal_generator/cli.rb

@@ -0,0 +1,21 @@
+require "thor"
+require "yaml"
+require "json"
+require "logger"
+require "recursive-open-struct"
+require "jekyll_reveal_generator/defaults"
+require "jekyll_reveal_generator/create_new_presentation"
+require "jekyll_reveal_generator/create_slide"
+
+$logger = Logger.new(STDERR)
+
+module JekyllRevealGenerator
+  class Cli < Thor
+    include Thor::Actions
+
+    add_runtime_options!
+
+    register(JekyllRevealGenerator::CreateNewPresentation, "init", "init", "Creates a new jekyll-reveal presentation")
+    register(JekyllRevealGenerator::CreateSlide, "slide", "slide", "Create a new slide")
+  end
+end

data/lib/jekyll_reveal_generator/create_new_presentation.rb

@@ -0,0 +1,108 @@
+require "yaml"
+require "thor"
+
+module JekyllRevealGenerator
+  class CreateNewPresentation < Thor::Group
+    include Thor::Actions
+
+    add_runtime_options!
+
+    desc "Creates a new Jekyll-Reveal Presentation"
+    argument :folder, type: :string, desc: "Folder to generate new presention"
+
+    attr_accessor :init_options
+
+    def init
+      self.init_options = RecursiveOpenStruct.new({
+          title: '',
+          description: '',
+          author: {
+            name: '',
+            email: '',
+            twitter: '',
+            github: ''
+          },
+          venue: {
+            name: '',
+            ssid: '',
+            password: ''
+          },
+          publishing: {
+            site_url: '',
+            base_url: '',
+            destination: 'docs'
+          }
+        }
+          .merge({"folder" => folder})
+          .merge(options))
+
+      self.init_options.title = ask("Title of presentation:", :green)
+      if init_options.title.match(%r{\A\s*\z})
+        $logger.error("You must give a title")
+        exit -1;
+      end
+      self.init_options.description = ask("Description:")
+      self.init_options.author.name = ask("Author's name:")
+      self.init_options.author.email = ask("Author's email:")
+      self.init_options.author.twitter = ask("Author's twitter handle:")
+      self.init_options.author.github = ask("Author's github name:")
+      self.init_options.venue.name = ask("Name of venue:", default: "T.B.D.")
+      self.init_options.venue.ssid = ask("What is the SSID?", default: "T.B.D.")
+      self.init_options.venue.password = ask("What is the network password? ", default: "T.B.D.")
+      self.init_options.publishing.site_url = ask("What is the published site url?")
+      self.init_options.publishing.base_url = ask("What is the base URL for the published site?")
+      self.init_options.publishing.destination = ask("What is the destination folder for the published site?", default: "docs")
+
+      puts init_options.to_h.to_yaml
+      unless yes?("Is this correct?", :red)
+        $logger.error("quitting, try again")
+        exit -1;
+      end
+      puts "Creating site"
+    end
+
+    def self.source_root
+      File.expand_path("../../../templates", __FILE__)
+    end
+
+    def intiialize_directory
+      config = {
+        verbose: init_options.quiet || true,
+        force: init_options.force || false,
+        pretend: init_options.pretend || false,
+        quiet: init_options.quient || false
+      }
+      empty_directory(init_options.folder, config)
+      destination_root = init_options.folder
+      directory("presentation", init_options.folder, config)
+    end
+
+    def initialize_presentation
+      if defined? Bundler
+        Bundler.with_clean_env do
+          run_initial_directory_setup
+        end
+      else
+        run_initial_directory_setup
+      end
+    end
+
+    def final_message
+      msg = File.read(File.expand_path("../final_message.txt", __FILE__))
+      say(msg, :green)
+    end
+
+    private
+
+    def run_initial_directory_setup
+      inside(init_options.folder) do
+        run 'git init'
+        run 'sh setup.sh'
+        run 'git add --all -v'
+        run 'git commit -m "Initial Commit"'
+      end
+    end
+
+  end
+
+end

data/lib/jekyll_reveal_generator/create_slide.rb

@@ -0,0 +1,82 @@
+require "recursive-open-struct"
+require "yaml"
+require "thor"
+require "jekyll_reveal_generator/utils"
+require "pathname"
+
+module JekyllRevealGenerator
+  class CreateSlide < Thor::Group
+    include Thor::Actions
+    include JekyllRevealGenerator::Utils
+
+    SLIDE_STYLES = [
+      'blank',
+      'bullet',
+      'image_left',
+      'image_right',
+      'multi',
+      'standard',
+      'title',
+      'two_up'
+    ]
+
+    SLIDE_FORMATS = ['html', 'markdown']
+
+
+    add_runtime_options!
+
+    class_option(:working_dir, default: Pathname.pwd,
+      desc: "Working Directory; root of presentation",
+      type: :string, aliases: ['--WD'])
+
+    desc "Creates a new slide"
+
+    attr_accessor :slide_options
+
+    def slide
+
+      self.slide_options = RecursiveOpenStruct.new({
+          title: '',
+          group: 0,
+          sequence: 0,
+          slug: '',
+          format: 'html',
+          style: 'standard'
+        }
+          .merge(options))
+
+      self.slide_options.working_dir = Pathname.new(slide_options.working_dir)
+
+      Dir.chdir(slide_options.working_dir) do |wd|
+        self.slide_options.group = ask("Group?", default: last_slide_group).to_i
+        $logger.debug("slide_options.group: #{slide_options.group}")
+        self.slide_options.sequence = ask("Sequence?", default: last_slide_sequence(slide_options.group) + 1).to_i
+      end
+
+      self.slide_options.title = ask("Title of slide?")
+      self.slide_options.slug = ask("Slide slug?", default: slide_slug(slide_options))
+      self.slide_options.format = ask("Format? [#{SLIDE_FORMATS.join(", ")}]", limit_to: SLIDE_FORMATS, default: slide_options.format)
+      self.slide_options.style = ask("Slide style? [#{SLIDE_STYLES.join(", ")}]",
+        limit_to: SLIDE_STYLES,
+        default: 'standard')
+      $logger.debug("Slide Options: \n#{slide_options.to_h.to_yaml}")
+    end
+
+    def self.source_root
+      File.expand_path("../../../templates/slides", __FILE__)
+    end
+
+    def create_slide
+      source="#{slide_options.style}_slide.#{slide_options.format}"
+      $logger.debug("template_file: #{source}")
+      target_file="#{slide_options.slug}.#{slide_options.format}"
+      $logger.debug("target_file: #{target_file}")
+      destination=slide_options.working_dir.join("source", "_slides", target_file)
+      $logger.debug("destination: #{destination}")
+      template(source, destination)
+    end
+
+
+  end
+
+end

data/lib/jekyll_reveal_generator/defaults.rb

@@ -0,0 +1,56 @@
+
+module JekyllRevealGenerator
+
+  DEFAULT_CONFIGURATION = {
+    title: 'My Cool Talk',
+    subtitle: "It's the bee's knees",
+    author: {
+      name: 'Nobody',
+      email: 'nobody@example.com',
+      github: nil,
+      twitter: nil
+    },
+    collections: [
+      'slides'
+    ],
+    exclude: [
+      'bs-config.js',
+      'package.json',
+      'node_modules'
+    ],
+    kramdown: {
+      input: 'GFM',
+      hard_wrap: false,
+      parse_block_html: true,
+      parse_span_html: true
+    }
+  }
+
+  DEFAULT_PUBLISH_CONFIGURATION = {
+    url: '',
+    baseurl: ''
+  }
+
+
+  DEFAULT_PACKAGE_JSON = {
+    name: 'my-cool-talk',
+    version: JekyllRevealGenerator::VERSION,
+    description: "My cool talk",
+    main: "index.js",
+    scripts: {
+      "jekyll:serve": "bundle exec jekyll serve",
+      "jekyll:build": "bundle exec jekyll build --config=_configy.yml,_publish.yml",
+      "bs:serve": "browser-sync start --config bs-config.js",
+      "start": "concurrently \"npm run bs:serve\" \"npm run jekyll:serve\"",
+      "test": "echo \"Error: no tests specified\" && exit 1"
+    },
+    author: 'nobody',
+    license: "MIT"
+  }
+
+  NPM_PACKAGES = [
+    'browser-sync',
+    'concurrently'
+  ]
+
+end

data/lib/jekyll_reveal_generator/final_message.txt

@@ -0,0 +1,34 @@
+
+Congratulations, your new presentation is now ready
+for editing.
+
+You can start up a server that will point to http://localhost:4000
+
+    cd #{init_options.folder}
+    bin/rake serve
+
+If you add any node.js components, you can add to the setup.sh
+script, it would be a good place to add the "npm install" or
+"yarn" command.
+
+I've already performed the initial git commit. You should keep
+committing changes as you go along.
+
+The "_publish.yml" file is used to modify the links and the
+destination directory for publishing. This is mainly set up
+for publishing to github pages using the "docs/" directory on
+the master branch. If you want to go this way, the "_publish.yml"
+file settings should be something like:
+
+    url: "https://YOURGITHUB.github.io"
+    baseurl: "/REPO_NAME"
+    destination: docs
+
+In the REPO_NAME settings you can specify the location for
+your github pages.
+
+When you want to add slides, you can run "jrg" from the
+presentation root and answer the questions.
+
+    cd #{init_options.folder}
+    jrg slide

data/lib/jekyll_reveal_generator/utils.rb

@@ -0,0 +1,59 @@
+require "pathname"
+
+module JekyllRevealGenerator
+
+  module Utils
+
+    def slide_slug(o)
+      pattern = "%02d-%02d-%s"
+      pattern % [
+        o.group.to_i,
+        o.sequence.to_i,
+        o.title.downcase
+          .gsub(/[^[:alnum:]]+/,'-')
+          .sub(/-+\z/,'')
+      ]
+    end
+
+    def group_num(file)
+      file.to_s.split("-")[0].to_i
+    end
+
+    def sequence_num(file)
+      file.to_s.split("-")[1].to_i
+    end
+
+    def last_slide_group(files=nil)
+      files ||= slide_files
+      files
+        .map{|file| group_num(file) }
+        .uniq.sort.last
+    end
+
+    def last_slide_sequence(group, files=nil)
+      files ||= slide_files
+      files
+        .reject{|file| group != group_num(file) }
+        .map{|file| sequence_num(file)}
+        .uniq.sort.last || -1
+    end
+
+    def slides
+      @slides ||= source.join(source, '_slides')
+    end
+
+    def slide_files
+      @slide_files ||= slides.children
+        .map{|f| f.basename}
+    end
+
+    def source
+      @source ||= root_dir.join("source")
+    end
+
+    def root_dir(dir=nil)
+      @root_dir ||= (dir ? Pathname.new(dir) : Pathname.pwd)
+    end
+
+  end                                   # module Utils
+end

data/lib/jekyll_reveal_generator/version.rb

@@ -0,0 +1,3 @@
+module JekyllRevealGenerator
+  VERSION = "0.2.0.alpha"
+end

data/lib/jekyll_reveal_generator.rb

@@ -0,0 +1,6 @@
+require "thor"
+require "jekyll_reveal_generator/version"
+require "jekyll_reveal_generator/cli"
+
+module JekyllRevealGenerator
+end

data/templates/presentation/.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+*.log
+_site/
+_reveal.js-master/

data/templates/presentation/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gem "jekyll"
+gem "rake"

data/templates/presentation/Rakefile

@@ -0,0 +1,11 @@
+
+desc "Run the jekyll development server"
+task :serve do |t|
+  sh 'bundle exec jekyll serve --config=_config.yml'
+end
+
+
+desc "Build the published version"
+task :publish do |t|
+  sh 'bundle exec jekyll build --config=_config.yml,_publish.yml'
+end

data/templates/presentation/_config.yml

@@ -0,0 +1,12 @@
+# Jekyll configuration file
+source: source
+destination: build
+markdown: kramdown
+kramdown:
+  input: GFM
+  hard_wrap: false
+  parse_block_html: true
+  parse_span_html: true
+
+collections:
+  - slides