code_slide 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aebc8a3009b9b263056b648e126f867b1b8dca98
+  data.tar.gz: 8f306a98bf274c541c4c65a4d6c5c6c9a9e3c118
+SHA512:
+  metadata.gz: f1ea745fc473cabdf4a48679e6da926a8f6074611e3d82ea1054f51eecc00d3a42d6aaff6e66a0b9596a7c3971a504b4c39b8c5ea1b41fcdabb75acac11321d9
+  data.tar.gz: ea9222bc9825af6abf019abfee1496db11f507234d72a87e52995e79bcdc86dbec9df4f20cf43fe12ea1db2493e02ca530e6bbe4415f379ff69333621e7ecd5b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jamis Buck
+
+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,82 @@
+# CodeSlide
+
+A library for turning code snippets into slides. Automatically turn your
+source code into syntax-highlighted PDFs and PNGs. Take the tedium out of
+building your presentation's slide deck!
+
+
+## Installation
+
+If you want to be able to automatically generate PNG files, you'll need to have
+GhostScript installed (https://ghostscript.com/).
+
+Aside from that, installation is as easy as:
+
+    $ gem install code_slide
+
+And you're good to go!
+
+
+## Usage
+
+Look in the `examples` directory for some demonstrations of CodeSlide. In
+brief, though, it works like this:
+
+```ruby
+require 'code_slide'
+
+snippet = CodeSlide::Snippet.new(<<-RUBY, lang: :ruby)
+1.upto(100) do |n|
+  print 'Fizz' if (n % 3).zero?
+  print 'Buzz' if (n % 5).zero?
+  puts if (n % 3).zero? || (n % 5).zero?
+end
+RUBY
+
+snippet.make_pdf('snippet.pdf')
+```
+
+You can also source your snippet from a file directly, even specifying which
+range of lines you want to use:
+
+```ruby
+snippet = CodeSlide::Snippet.from_file('fizz-buzz.rb', start: 5, finish: 15)
+snippet.make_pdf('snippet.pdf')
+```
+
+If you have a (TTF) font you want to use, you can specify the different faces
+in the family, and instruct CodeSlide to use them:
+
+```ruby
+snippet = CodeSlide::Snippet.from_file('fizz-buzz.rb', start: 5, finish: 15)
+snippet.use_font('myfont-regular.ttf',
+                 bold: 'myfont-bold.ttf',
+                 italic: 'myfont-italic.ttf',
+                 bold_italic: 'myfont-bold-italic.ttf')
+snippet.make_pdf('snippet.pdf')
+```
+
+You can choose between the "light" and "dark" themes (or make your own):
+
+```ruby
+snippet = CodeSlide::Snippet.from_file('fizz-buzz.rb', theme: :dark)
+snippet.make_pdf('dark-snippet.pdf')
+```
+
+And if you want to generate a PNG directly, you can do that too (though again,
+you need to have GhostScript installed):
+
+```ruby
+snippet.make_png('snippet.png')
+```
+
+
+## License
+
+This software is released under the terms of the MIT license. See the
+`MIT-LICENSE` for full details.
+
+
+## Author
+
+This software is written and distributed by Jamis Buck <jamis@jamisbuck.org>.

data/lib/code_slide.rb

@@ -0,0 +1,2 @@
+require 'code_slide/snippet'
+require 'code_slide/version'

data/lib/code_slide/analyzer.rb

@@ -0,0 +1,134 @@
+require 'coderay'
+require 'nokogiri'
+require 'code_slide/theme_manager'
+
+module CodeSlide
+  class Analyzer
+    attr_reader :elements
+    attr_reader :width
+    attr_reader :height
+    attr_reader :styles
+    attr_reader :gutter_width
+
+    def initialize(text, options = {})
+      @styles = options[:styles] ||
+                (options[:theme] && ThemeManager.load_theme(options[:theme])) ||
+                ThemeManager.load_theme(:light)
+
+      line_numbers = options[:line_numbers] && :inline
+      bold_every   = options[:bold_every] || nil
+      line_start   = options[:line_number_start] || 1
+
+      text = _preprocess_text(text)
+      _compute_gutter(line_numbers, line_start)
+      html = _generate_html(text, options[:lang],
+                            line_numbers, line_start, bold_every)
+
+      _format_html(html)
+    end
+
+    def _compute_gutter(line_numbers, line_start)
+      @gutter_width = 0
+      return unless line_numbers
+
+      max = line_start + height
+      @gutter_width = Math.log10(max + 1).ceil + 1
+    end
+
+    def _generate_html(text, lang, line_numbers, line_start, bold_every)
+      CodeRay.scan(text, lang).
+        html(line_numbers: line_numbers,
+             line_number_anchors: false,
+             line_number_start: line_start,
+             bold_every: bold_every).
+        gsub(%r{</strong>}, '</span>').
+        gsub(/<strong>/, '<span class="highlight">')
+    end
+
+    # removes leading and trailing blank lines
+    def _preprocess_text(text)
+      lines = text.lines.map(&:rstrip)
+      lines.delete_at(0) while lines[0].empty?
+      lines.delete_at(-1) while lines[-1].empty?
+
+      @width = lines.map(&:length).max
+      @height = lines.length
+
+      lines.join("\n")
+    end
+
+    def _format_html(html)
+      doc = Nokogiri::HTML.fragment(html)
+
+      @current_attributes = [{}]
+      @elements = []
+
+      _format(doc)
+    end
+
+    def _format(parent)
+      style = _lookup_class(parent['class'])
+      @current_attributes.push(_merge_style(style))
+      parent.children.each { |child| _format_node(child) }
+    ensure
+      attrs = @current_attributes.pop
+      @elements.last[:text] << attrs[:after] if attrs[:after]
+    end
+
+    def _format_node(node)
+      if node.text?
+        @elements << _style(node)
+      elsif node.element?
+        _format(node)
+      else
+        raise 'unknown node type'
+      end
+    end
+
+    def _style(node)
+      text = _text(node)
+      attrs = @current_attributes.last
+      attrs.merge(text: text)
+    end
+
+    def _merge_style(style)
+      styles = @current_attributes.last[:styles]
+      if style[:styles]
+        styles ||= []
+        styles = [*style[:styles], *styles]
+      end
+
+      @current_attributes.last.merge(style).tap do |attrs|
+        attrs[:styles] = styles if styles
+
+        # 'after' is never inherited
+        attrs[:after] = nil unless style[:after]
+      end
+    end
+
+    def _lookup_class(class_name)
+      return (@styles[:default] || {}) unless class_name
+
+      class_name && (@styles[class_name] || @styles[class_name.to_sym]) ||
+        begin
+          warn "no definition for #{class_name}"
+          { class: class_name }
+        end
+    end
+
+    ENTITY = {
+      'lt'   => '<',
+      'gt'   => '>',
+      'amp'  => '&'
+    }.freeze
+
+    def _text(text)
+      text.to_s.
+        tr(' ', "\u00A0").
+        gsub(/\&(.*?);/) do |match|
+          entity = Regexp.last_match(1)
+          ENTITY[entity.downcase] || match
+        end
+    end
+  end
+end

data/lib/code_slide/pdf_formatter.rb

@@ -0,0 +1,93 @@
+require 'prawn'
+
+module CodeSlide
+  class PDFFormatter
+    def initialize(analyzer)
+      @analyzer = analyzer
+    end
+
+    def use_font(path, bold: path, italic: path, bold_italic: path)
+      @font = path
+      @bold = bold
+      @italic = italic
+      @bold_italic = bold_italic
+
+      self
+    end
+
+    def build_pdf(gravity: :center,
+                  background_color: nil,
+                  font_size: 16, page_width: 792, page_height: 612)
+      Prawn::Document.new(page_size: [page_width, page_height]).tap do |pdf|
+        Prawn::Font::AFM.hide_m17n_warning = true
+
+        _prepare_background(pdf, background_color)
+        pdf.font _prepare_font(pdf), size: font_size
+        options = _prepare_options(pdf, gravity)
+
+        box = Prawn::Text::Formatted::Box.new(@analyzer.elements, options)
+        box.render
+      end
+    end
+
+    def _prepare_background(pdf, bgcolor)
+      bgcolor ||= @analyzer.styles[:background] &&
+                  @analyzer.styles[:background][:color]
+      return unless bgcolor
+
+      pdf.canvas do
+        pdf.fill_color bgcolor
+        pdf.fill_rectangle [pdf.bounds.left, pdf.bounds.top],
+                           pdf.bounds.right, pdf.bounds.top
+      end
+    end
+
+    def _prepare_font(pdf)
+      if @font.nil?
+        'Courier'
+      else
+        pdf.font_families.update(
+          'Custom' => { normal: @font,
+                        bold: @bold,
+                        italic: @italic,
+                        bold_italic: @bold_italic })
+        'Custom'
+      end
+    end
+
+    def _prepare_options(pdf, gravity)
+      width = pdf.width_of('M') * @analyzer.width
+      height = pdf.height_of('M') * @analyzer.height
+
+      width += @analyzer.gutter_width
+
+      {
+        document: pdf,
+        overflow: :overflow,
+        at: _box_position(pdf, width, height, gravity)
+      }
+    end
+
+    def _box_position(pdf, width, height, gravity)
+      left    = 0
+      hcenter = (pdf.bounds.width - width) / 2
+      right   = pdf.bounds.width - width
+      top     = pdf.bounds.height
+      vcenter = pdf.bounds.height - (pdf.bounds.height - height) / 2
+      bottom  = height
+
+      case gravity
+      when :northwest then [left,    top    ]
+      when :north     then [hcenter, top    ]
+      when :northeast then [right,   top    ]
+      when :west      then [left,    vcenter]
+      when :center    then [hcenter, vcenter]
+      when :east      then [right,   vcenter]
+      when :southwest then [left,    bottom ]
+      when :south     then [hcenter, bottom ]
+      when :southeast then [right,   bottom ]
+      else raise ArguentError, "unsupported gravity #{gravity.inspect}"
+      end
+    end
+  end
+end

data/lib/code_slide/png_formatter.rb

@@ -0,0 +1,12 @@
+module CodeSlide
+  class PNGFormatter
+    def initialize(pdf_filename)
+      @pdf_filename = pdf_filename
+    end
+
+    def generate_png(filename, dpi: 300, keep_pdf: false)
+      system 'gs -q -sDEVICE=png16m -dTextAlphaBits=4 ' \
+             "-r#{dpi} -o #{filename} #{@pdf_filename}"
+    end
+  end
+end

data/lib/code_slide/snippet.rb

@@ -0,0 +1,72 @@
+require 'code_slide/analyzer'
+require 'code_slide/pdf_formatter'
+require 'code_slide/png_formatter'
+
+module CodeSlide
+  class Snippet
+    def self.from_file(filename, options = {})
+      options = options.dup
+
+      start = options.delete(:start) || 1
+      finish = options.delete(:finish) || -1
+
+      line_start = options[:line_number_start] || start
+
+      # assume people number their file lines starting at 1
+      start -= 1 if start > 0
+      finish -= 1 if finish > 0
+
+      text = File.read(filename).lines[start..finish].join
+      new(text,
+          options.merge(lang: options[:lang] || detect_language_type(filename),
+                        line_number_start: line_start))
+    end
+
+    EXTMAP = { # rubocop:disable Style/MutableConstant
+      '.rb'   => :ruby,
+      '.py'   => :python,
+      '.c'    => :c,
+      '.java' => :java
+    }
+
+    def self.detect_language_type(filename)
+      EXTMAP[File.extname(filename).downcase]
+    end
+
+    def initialize(snippet, options = {})
+      @analyzer = CodeSlide::Analyzer.new(snippet, options)
+      use_font(nil)
+    end
+
+    def use_font(path, bold: path, italic: path, bold_italic: path)
+      @font = path
+      @bold = bold
+      @italic = italic
+      @bold_italic = bold_italic
+
+      self
+    end
+
+    def make_pdf(filename, options = {})
+      PDFFormatter.new(@analyzer).
+        use_font(@font, bold: @bold,
+                        italic: @italic,
+                        bold_italic: @bold_italic).
+        build_pdf(options).
+        render_file(filename)
+    end
+
+    def make_png(filename, options = {})
+      options = options.dup
+      dpi = options.delete(:dpi)
+      keep_pdf = options.delete(:keep_pdf)
+
+      pdf_name = File.basename(filename, File.extname(filename)) + '.pdf'
+
+      make_pdf(pdf_name, options)
+      PNGFormatter.new(pdf_name).
+        generate_png(filename, dpi: dpi)
+      File.delete(pdf_name) unless keep_pdf
+    end
+  end
+end

data/lib/code_slide/theme_manager.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module CodeSlide
+  class ThemeManager
+    @search_paths = []
+    @search_paths << '.'
+    @search_paths << File.join(File.dirname(__FILE__), 'themes')
+
+    @cached_themes = {}
+
+    class <<self
+      attr_reader :search_paths
+
+      def load_theme(name)
+        @cached_themes[name] ||= begin
+          file_name = "#{name}.yml"
+          path = @search_paths.
+                 map { |s| File.join(s, file_name) }.
+                 find { |s| File.exist?(s) }
+
+          if path.nil?
+            raise ArgumentError, "couldn't find theme #{name.inspect}"
+          end
+
+          _post_process(YAML.load_file(path))
+        end
+      end
+
+      def _post_process(hash)
+        hash.each.with_object({}) do |(key, value), result|
+          key = key.to_sym
+          result[key] = _post_process_value(key, value)
+        end
+      end
+
+      def _post_process_value(key, value)
+        if key == :styles
+          value.map(&:to_sym)
+        elsif value.is_a?(Hash)
+          _post_process(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/code_slide/themes/dark.yml

@@ -0,0 +1,48 @@
+# modeled after Atom's "One Dark" syntax theme
+---
+background:
+  color: '282c34'
+default:
+  color: 'abb2be'
+
+comment:
+  color: '5c636f'
+  styles: [ italic ]
+
+keyword:
+  color: 'c57bdb'
+class:
+  color: 'd09a6a'
+constant:
+  color: 'd09a6a'
+function:
+  color: '65b0ec'
+string:
+  color: '99c27c'
+delimiter:
+  color: '99c27c'
+inline:
+  color: '99c27c'
+content:
+  color: '99c27c'
+symbol:
+  color: '5ab6c1'
+key:
+  color: '5ab6c1'
+integer:
+  color: 'd09a6a'
+float:
+  color: 'd09a6a'
+predefined-constant:
+  color: 'd09a6a'
+inline-delimiter:
+  color: 'bc5149'
+instance-variable:
+  color: 'de6d77'
+
+highlight:
+  color: '999999'
+  styles: [ bold ]
+line-numbers:
+  color: '555555'
+  after: ' '

data/lib/code_slide/themes/light.yml

@@ -0,0 +1,48 @@
+# modeled after Atom's "One Light" syntax theme
+---
+background:
+  color: 'ffffff'
+default:
+  color: '000000'
+
+comment:
+  color: 'a0a1a7'
+  styles: [ italic ]
+
+keyword:
+  color: 'a42ea2'
+class:
+  color: 'c0831e'
+constant:
+  color: 'c0831e'
+function:
+  color: '447bee'
+string:
+  color: '53a053'
+delimiter:
+  color: '53a053'
+inline:
+  color: '53a053'
+content:
+  color: '53a053'
+symbol:
+  color: '1485ba'
+key:
+  color: '1485ba'
+integer:
+  color: '976715'
+float:
+  color: '976715'
+predefined-constant:
+  color: '976715'
+inline-delimiter:
+  color: 'c81846'
+instance-variable:
+  color: 'e2574e'
+
+highlight:
+  color: '999999'
+  styles: [ bold ]
+line-numbers:
+  color: 'bbbbbb'
+  after: ' '

data/lib/code_slide/version.rb

@@ -0,0 +1,3 @@
+module CodeSlide
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: code_slide
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jamis Buck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: |2
+      A library for turning code snippets into slides. Automatically turn your
+      source code into syntax-highlighted PDFs and PNGs. Take the tedium out
+      of building your presentation's slide deck!
+email:
+- jamis@jamisbuck.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/code_slide.rb
+- lib/code_slide/analyzer.rb
+- lib/code_slide/pdf_formatter.rb
+- lib/code_slide/png_formatter.rb
+- lib/code_slide/snippet.rb
+- lib/code_slide/theme_manager.rb
+- lib/code_slide/themes/dark.yml
+- lib/code_slide/themes/light.yml
+- lib/code_slide/version.rb
+homepage: https://github.com/jamis/code_slide
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generate PDF/PNG slides from source code
+test_files: []