lecture 1.0.0

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 npezza93
+
+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,145 @@
+# Lecture
+
+Lecture is a way to present a slideshow through the terminal. All slides are written
+in Ruby. There is an example in the examples folder, found [here](https://github.com/npezza93/lecture/tree/master/examples).
+
+## Installation
+
+```bash
+  ❯ gem install lecture
+```
+
+## Usage
+
+```bash
+  ❯ lecture #{slides.rb}
+```
+
+### Configuration
+
+At the top of your slides.rb file you can use the `configure` method to configure
+settings within Lecture.
+
+```ruby
+configure do |lecture|
+  lecture.section_footer_text = "───"
+end
+```
+
+Configurable settings include:
+- character_print_delay
+- transition_time
+- pygment_style
+- section_header_text
+- section_footer_text
+
+### Slide Types
+
+When writing your slides.rb file you have four slide types available.
+
+#### center
+
+A center slide centers every line on the screen horizontally and vertically.
+
+```ruby
+  center <<~SLIDE
+    Hello
+
+
+    This is a slide
+  SLIDE
+```
+
+![Center](https://raw.github.com/npezza93/lecture/master/screenshots/center.png)
+
+#### block
+
+A block slide preserves the text formatting, but centers the slide as a whole on the screen.
+
+
+```ruby
+block <<~SLIDE
+  The lines in this block of text are
+  not centered
+SLIDE
+```
+
+![Block](https://raw.github.com/npezza93/lecture/master/screenshots/block.png)
+
+#### section
+
+A section slide has a title and draws a centered string of text above and below the title (default: " § ").
+It can be configured with the `section_header_text` and `section_footer_text` keys.
+
+Sections allow you to group slides in your Ruby slide deck, and can yield to a block to promote slide organization.
+
+```ruby
+section("This is a section") do
+  center("This is a centered slide inside a section")
+end
+```
+
+![Section](https://raw.github.com/npezza93/lecture/master/screenshots/section.png)
+
+#### code
+
+A code slide contains source code and has syntax highlighting.
+
+The code method requires a second keyword argument with the name of the programming language.
+
+The syntax highlighting style can be configured with the `pygment_style` key. Styles can be found [here](https://github.com/tmm1/pygments.rb), default is `paraiso-dark`.
+
+```ruby
+code(%(
+  class PostsController < ApplicationController
+    def index
+      @posts = Post.all
+    end
+  end
+), lexer: :ruby)
+```
+
+![Code](https://raw.github.com/npezza93/lecture/master/screenshots/code.png)
+
+### Keyboard Controls
+
+- <kbd>SPACE</kbd> or <kbd>→</kbd> go to the next slide
+- <kbd>←</kbd> go to the previous slide
+- <kbd>a</kbd> jumps to the first slide of the deck
+- <kbd>d</kbd> jumps to the last slide of the deck
+- <kbd>j</kbd> followed by a slide number(0 index) jumps to the given slide
+- <kbd>w</kbd> redraws the slide
+- <kbd>q</kbd> or <kbd>ESC</kbd> exits the slideshow
+
+### String Utilities
+
+You have a variety of string colors and modes available when creating slides. To get a list of colors and modes you can use: `Lecture.available_colors` and `Lecture.available_modes`.
+
+```ruby
+center <<~SLIDE
+  #{'Slide'.bold}
+
+
+  This is a #{'slide'.green}
+SLIDE
+```
+
+You can also use ANSI escape sequences and unicode characters to spice up your slides.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/npezza93/lecture.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+---
+
+Inspired by [fxn/tkn](https://github.com/fxn/tkn)

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "lecture"
+
+# You can add fixtures and/or initialization code here to make experimenting
+def reload!(print = true)
+  puts "Reloading..." if print
+  files = $LOADED_FEATURES.select do |feat|
+    feat =~ /\/lecture\//
+  end
+  files.each { |file| load file }
+  true
+end
+
+require "pry"
+Pry.start

data/bin/lecture

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + "/../lib")
+
+require "bundler/setup"
+require "lecture"
+require "getoptlong"
+
+opts = GetoptLong.new(["--help", "-h", GetoptLong::NO_ARGUMENT])
+opts.each do |opt, _|
+  next unless opt == "--help"
+
+  puts Lecture::HELP
+  exit 0
+end
+
+if ARGV.empty?
+  puts "lecture: A file must be supplied\n\n"
+  puts Lecture::HELP
+  exit 1
+end
+
+unless File.exist?(slide_deck = ARGV[0])
+  puts "lecture: Can't find slide deck '#{slide_deck}'"
+  exit 1
+end
+
+Lecture.execute(slide_deck)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/examples/example.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+configure do |lecture|
+  lecture.section_footer_text = "───"
+end
+
+center <<~SLIDE
+  Hello
+
+
+  This is a slide
+SLIDE
+
+center <<~SLIDE
+  #{'Slide 2'.bold}
+
+
+  This is the #{'second'.green} slide
+SLIDE
+
+code(%(
+  # app/controllers/posts_controller.rb
+
+  class PostsController < ApplicationController
+    def index
+      @posts = Post.all
+    end
+  end
+), lexer: :ruby)
+
+section("This is a section") do
+  center("This is a centered slide inside a section")
+end
+
+block("The lines in this block of text are\nnot centered")

data/lecture.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "lecture/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lecture"
+  spec.version       = Lecture::VERSION
+  spec.authors       = ["npezza93"]
+  spec.email         = ["npezza93@gmail.com"]
+
+  spec.summary       = "Terminal Slideshow"
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = ["lecture"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pygments.rb"
+  spec.add_dependency "colorize"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest"
+end

data/lib/lecture.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "pygments.rb"
+require "colorize"
+require "io/console"
+require "active_support/all"
+
+require "lecture/version"
+require "lecture/config"
+require "lecture/terminal"
+require "lecture/slide"
+
+module Lecture
+  mattr_writer :pygment_style, :character_print_delay, :slide_types,
+               :transition_time, :section_header_text, :section_footer_text
+
+  def self.character_print_delay
+    @@character_print_delay || 0.018
+  end
+
+  def self.transition_time
+    @@transition_time || 0.3
+  end
+
+  def self.pygment_style
+    @@pygment_style || "paraiso-dark"
+  end
+
+  def self.slide_types
+    @@slide_types ||= Set.new
+  end
+
+  def self.section_header_text
+    @@section_header_text ||= " § "
+  end
+
+  def self.section_footer_text
+    @@section_footer_text ||= " § "
+  end
+
+  def self.available_colors
+    String.colors
+  end
+
+  def self.available_modes
+    String.modes
+  end
+
+  def self.execute(deck)
+    Runner.new(deck).execute
+  end
+
+  HELP = <<~HELP
+    #{'VERSION'.bold} #{Lecture::VERSION}
+
+    #{'NAME'.bold}
+      lecture - Terminal Slideshow
+
+    #{'SYNOPSIS'.bold}
+      lecture [--help] <slides>.rb
+
+    #{'OPTIONS'.bold}
+      -h, --help
+         Print this help
+
+    #{'COMMANDS'.bold}
+      Next slide:        SPC, Right Arrow
+      Previous slide:    Left Arrow
+      First slide:       a
+      Last slide:        d
+      Jump to slide:     j
+      Reload slide:      w
+      Quit:              q
+
+    #{'SLIDE TYPES'.bold}
+      code               Highlighted block of code
+      center             All lines are centered on the screen
+      block              The section of text is centered as whole
+      section            A stylized section identifier slide
+  HELP
+end
+
+require "lecture/slide/base"
+require "lecture/slide/center"
+require "lecture/slide/code"
+require "lecture/slide/section"
+require "lecture/slide/block"
+
+require "lecture/runner"

data/lib/lecture/config.rb

@@ -0,0 +1,23 @@
+module Lecture
+  class Config
+    def character_print_delay=(value)
+      Lecture.character_print_delay = value
+    end
+
+    def transition_time=(value)
+      Lecture.transition_time = value
+    end
+
+    def pygment_style=(value)
+      Lecture.pygment_style = value
+    end
+
+    def section_header_text=(value)
+      Lecture.section_header_text = value
+    end
+
+    def section_footer_text=(value)
+      Lecture.section_footer_text = value
+    end
+  end
+end

data/lib/lecture/runner.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Lecture
+  class Runner
+    include Terminal
+
+    Lecture.slide_types.each do |format|
+      define_method(format) do |slide_content, **options, &block|
+        slides.push(
+          Slide.new(content: slide_content, format: format, **options)
+        )
+        block.call if block.present?
+      end
+    end
+
+    attr_accessor :current_slide, :slides, :deck
+
+    def initialize(deck)
+      @current_slide = 0
+      @slides        = []
+      @deck          = deck
+    end
+
+    def execute
+      instance_eval(File.read(deck))
+      first_slide
+
+      loop do
+        command_handler
+      end
+    end
+
+    def configure
+      yield(Config.new)
+    end
+
+    private
+
+    def command_handler
+      case getch
+      when " ", "\e[C" then next_slide
+      when "\e[D"      then prev_slide
+      when "a"         then first_slide
+      when "d"         then last_slide
+      when "j"         then jump_to
+      when "w"         then wipe
+      when "q", "\e"   then clear_and_exit
+      end
+    end
+
+    def display(slide_number)
+      clear
+      self.current_slide = slide_number
+
+      clear_and_exit if slides.length - 1 < current_slide
+
+      slides.at(current_slide).display
+
+      move_to(0, lines)
+    end
+
+    def jump_to
+      move_to(0, lines)
+      print "Jump to: "
+
+      display(STDIN.gets.strip.to_i)
+    end
+
+    def next_slide
+      display(current_slide + 1)
+    end
+
+    def prev_slide
+      display(current_slide - 1)
+    end
+
+    def first_slide
+      display(0)
+    end
+
+    def last_slide
+      display(slides.size - 1)
+    end
+
+    def wipe
+      display(current_slide)
+    end
+  end
+end