beamlet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 266bc21197b4454a0bf0c7c347e4a6649bd070d46362f031f9b283a245887128
+  data.tar.gz: c51fdd34c879e63a8e0d67f8cf5430eb9e7a554cd1ad1c4f2279822be6475203
+SHA512:
+  metadata.gz: a268426e495feea790f8912f3c3fac560ffda4ea51071ffc3c155efb66a7c218a8795acddea6203d142eb9cb9eedc3875916bf899d828197783842cbd34f8a03
+  data.tar.gz: 1df6b58f65ab93ef981429a6963af15647e168507bdbb1e7b8467343607815f1a6254945d92a98eaeb03c8b6573725bdf1fbf869d3e69736813664007f536875

data/bin/beamlet

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "beamlet"
+Beamlet::CLI.run(ARGV)

data/lib/beamlet/cli.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Beamlet
+  class CLI
+    def self.run(argv)
+      opts = parse(argv)
+      gen  = Generator.new(opts)
+
+      out = case opts[:mode]
+        when :document then gen.document
+        when :frame    then gen.frame
+        when :part     then gen.part
+        else
+          warn "Rien à générer. Essayez beamlet --help"
+          return 1
+      end
+
+      puts out
+      0
+    end
+
+    def self.parse(argv)
+      opts = { mode: nil, items: [], enum_items: [] }
+
+      parser = OptionParser.new do |o|
+        o.banner = "Usage: beamlet [options]"
+
+        o.on("-d", "--document", "Generate top-level document") do
+          opts[:mode] = :document
+        end
+        o.on("-f", "--frame", "Generate a frame") do
+          opts[:mode] = :frame
+        end
+
+        o.on("-T", "--title TITLE", "Document title")       { |v| opts[:title]  = v }
+        o.on("-a", "--author AUTHOR", "Author")             { |v| opts[:author] = v }
+        o.on("-i", "--date DATE", "Date")                   { |v| opts[:date]   = v }
+        o.on("--theme THEME", "Beamer theme (default Madrid)") { |v| opts[:theme] = v }
+        o.on("--[no-]titleframe", "Include title frame")    { |v| opts[:titleframe] = v }
+        o.on("-P", "--part", "Generate a part slide") do
+          opts[:mode] = :part
+        end
+        o.on("-p", "--part-title TITLE", "Part title") { |v| opts[:part_title] = v }
+        o.on("-t", "--frame-title TITLE", "Frame title")    { |v| opts[:frame_title] = v }
+        o.on("-s", "--splits N", Integer, "Split frame vertically into N columns") do |v|
+          opts[:splits] = v
+        end
+        o.on("--fragile", "Mark frame as fragile (for verbatim/code)") { opts[:fragile] = true }
+        o.on("--allowframebreaks", "Allow frame breaks")    { opts[:allowframebreaks] = true }
+
+        o.on("-l", "--itemize A,B,C", Array, "Itemize list (left by default)") do |v|
+          opts[:items] = v
+        end
+        o.on("-e", "--enumerate A,B,C", Array, "Enumerate list") do |v|
+          opts[:enum_items] = v
+        end
+        o.on("-b", "--block TITLE", "Add a standard block") do |v|
+          opts[:block_kind]  = "block"
+          opts[:block_title] = v
+          opts[:block_body]  = STDIN.tty? ? "contenu..." : $stdin.read.chomp
+        end
+        o.on("-A", "--alert TITLE", "Add an alertblock") do |v|
+          opts[:block_kind]  = "alertblock"
+          opts[:block_title] = v
+          opts[:block_body]  = STDIN.tty? ? "attention !" : $stdin.read.chomp
+        end
+        o.on("-E", "--example TITLE", "Add an exampleblock") do |v|
+          opts[:block_kind]  = "exampleblock"
+          opts[:block_title] = v
+          opts[:block_body]  = STDIN.tty? ? "exemple..." : $stdin.read.chomp
+        end
+
+        o.on("-I", "--image FILE", "Insert image")          { |v| opts[:image_file] = v }
+        o.on("--image-opts OPTS", "Image options (default width=0.8\\textwidth)") do |v|
+          opts[:image_opts] = v
+        end
+        o.on("-c", "--code LANG", "Code listing (body from stdin)") do |v|
+          opts[:code_lang] = v
+          opts[:code_body] = STDIN.tty? ? "# code" : $stdin.read.chomp
+          opts[:fragile]   = true
+        end
+        o.on("-p", "--pause", "Insert \\pause")             { opts[:pause] = true }
+        o.on("-n", "--note TEXT", "Speaker note")           { |v| opts[:note_body] = v }
+
+        o.on("-h", "--help", "Show help") { puts o; exit 0 }
+        o.on("-v", "--version", "Show version") { puts Beamlet::VERSION; exit 0 }
+      end
+
+      parser.parse!(argv)
+      opts
+    end
+  end
+end

data/lib/beamlet/generator.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Beamlet
+  class Generator
+    def initialize(opts = {})
+      @opts = default_opts.merge(opts)
+    end
+
+    def document
+      titleframe = @opts[:titleframe] ? Templates::TITLE_FRAME : ""
+      Templates::DOCUMENT % {
+        theme:      @opts[:theme],
+        title:      escape(@opts[:title]),
+        author:     escape(@opts[:author]),
+        date:       escape(@opts[:date]),
+        titleframe: titleframe,
+        body:       "% --- vos frames ici ---"
+      }
+    end
+
+    def part
+      Templates::PART % {
+        title: escape(@opts[:part_title] || "Partie")
+      }
+    end
+
+    def frame
+      body = build_body
+      body = split_into_columns(body, @opts[:splits]) if @opts[:splits] && @opts[:splits] > 1
+
+      options = []
+      options << "fragile" if @opts[:fragile]
+      options << "allowframebreaks" if @opts[:allowframebreaks]
+      opt_str = options.empty? ? "" : "[#{options.join(',')}]"
+
+      Templates::FRAME % {
+        options: opt_str,
+        title:   escape(@opts[:frame_title] || ""),
+        body:    indent(body, 2)
+      }
+    end
+
+    private
+
+    def default_opts
+      {
+        theme: "Madrid",
+        title: "Titre",
+        author: "Auteur",
+        date: "\\today",
+        titleframe: true,
+        splits: 1,
+        items: [],
+        enum_items: [],
+        block_kind: "block",
+        block_title: "",
+        block_body: "",
+        note_body: "",
+        image_file: "",
+        image_opts: "width=0.8\\textwidth",
+        code_lang: "ruby",
+        code_body: "",
+        fragile: false,
+        allowframebreaks: false,
+        pause: false
+      }
+    end
+
+    def build_body
+      parts = []
+
+      unless @opts[:items].empty?
+        parts << format_list(Templates::ITEMIZE, @opts[:items])
+      end
+
+      unless @opts[:enum_items].empty?
+        parts << format_list(Templates::ENUMERATE, @opts[:enum_items])
+      end
+
+      unless @opts[:block_body].empty?
+        parts << Templates::BLOCK % {
+          kind:  @opts[:block_kind],
+          title: escape(@opts[:block_title]),
+          body:  @opts[:block_body]
+        }
+      end
+
+      unless @opts[:image_file].empty?
+        parts << Templates::IMAGE % {
+          opts: @opts[:image_opts],
+          file: @opts[:image_file]
+        }
+      end
+
+      unless @opts[:code_body].empty?
+        parts << Templates::CODE % {
+          lang: @opts[:code_lang],
+          body: @opts[:code_body]
+        }
+      end
+
+      parts << Templates::PAUSE if @opts[:pause]
+
+      unless @opts[:note_body].empty?
+        parts << Templates::NOTE % { body: @opts[:note_body] }
+      end
+
+      parts.empty? ? "" : parts.join("\n\n")
+    end
+
+    def split_into_columns(body, n)
+      slices = body.split(/\n\n+/)
+      per_col = (slices.size.to_f / n).ceil
+      groups  = slices.each_slice(per_col).to_a
+      groups << [] while groups.size < n
+
+      width = (1.0 / n).round(2)
+      out = [Templates::COLUMNS_OPEN]
+      groups.each do |g|
+        out << "  " + Templates::COLUMN % { width: width }
+        g.each { |line| out << "    " + line }
+      end
+      out << Templates::COLUMNS_CLOSE
+      out.join("\n")
+    end
+
+    def format_list(template, items)
+      rendered = items.map { |i| escape(i) }.join("\n  \\item ")
+      template % { items: rendered }
+    end
+
+    def indent(str, n)
+      pad = " " * n
+      str.lines.map { |l| l.chomp.empty? ? l : pad + l }.join
+    end
+
+    def escape(s)
+      s.to_s.gsub("\\", '\textbackslash{}')
+        .gsub(/[&%$#_{}]/) { |m| "\\#{m}" }
+        .gsub("~", '\textasciitilde{}')
+    end
+  end
+end

data/lib/beamlet/templates.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Beamlet
+  module Templates
+    DOCUMENT = <<~'TEX'
+      \documentclass[10pt,aspectratio=169]{beamer}
+      \usetheme{%{theme}}
+      \useoutertheme{infolines} % Alternatively: infolines, miniframes, shadow, sidebar, smoothbars, smoothtree, split, tree
+      \usepackage[french]{babel}
+      \usepackage[utf8]{inputenc}
+      \usepackage[T1]{fontenc}
+      \usepackage{listings}
+      \usepackage{graphicx}
+
+      \title{%{title}}
+      \author{%{author}}
+      \date{%{date}}
+
+      \begin{document}
+      %{titleframe}
+      %{body}
+      \end{document}
+    TEX
+
+    PART = <<~'TEX'
+      \part{%{title}}
+      \frame{\partpage}
+    TEX
+
+    TITLE_FRAME = <<~'TEX'
+      \begin{frame}
+        \titlepage
+      \end{frame}
+    TEX
+
+    FRAME = <<~'TEX'
+      \begin{frame}%{options}
+        \frametitle{%{title}}
+      %{body}
+      \end{frame}
+    TEX
+
+    COLUMNS_OPEN  = '\begin{columns}[T]'
+    COLUMNS_CLOSE = '\end{columns}'
+    COLUMN        = '\column{%{width}\textwidth}'
+
+    ITEMIZE = <<~'TEX'
+      \begin{itemize}
+        \item %{items}
+      \end{itemize}
+    TEX
+
+    ENUMERATE = <<~'TEX'
+      \begin{enumerate}
+        \item %{items}
+      \end{enumerate}
+    TEX
+
+    BLOCK = <<~'TEX'
+      \begin{%{kind}}{%{title}}
+        %{body}
+      \end{%{kind}}
+    TEX
+
+    PAUSE = '\pause'
+
+    NOTE = <<~'TEX'
+      \note{%{body}}
+    TEX
+
+    IMAGE = <<~'TEX'
+      \begin{center}
+        \includegraphics[%{opts}]{%{file}}
+      \end{center}
+    TEX
+
+    CODE = <<~'TEX'
+      \begin{lstlisting}[language=%{lang}]
+      %{body}
+      \end{lstlisting}
+    TEX
+  end
+end

data/lib/beamlet/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Beamlet
+  VERSION = "0.1.0"
+end

data/lib/beamlet.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "beamlet/version"
+require_relative "beamlet/templates"
+require_relative "beamlet/generator"
+require_relative "beamlet/cli"
+
+module Beamlet
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: beamlet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean-Christophe Le Lann
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A small CLI tool to emit Beamer frames, documents, columns, lists and
+  blocks.
+executables:
+- beamlet
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/beamlet
+- lib/beamlet.rb
+- lib/beamlet/cli.rb
+- lib/beamlet/generator.rb
+- lib/beamlet/templates.rb
+- lib/beamlet/version.rb
+homepage: http://www.jcll.fr
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Generate LaTeX/Beamer snippets from the CLI
+test_files: []