tp 0.3.1 → 0.4.0

data/Readme.md

@@ -20,7 +20,7 @@ Terminal Presenter
 
 # tp
 
-Presents Markdown in your terminal
+Presents Markdown slides in your terminal
 
 # Installation
 
@@ -52,6 +52,16 @@ There can also be...
 
 ...multiple paragraphs.
 
+# Code
+
+\```rb
+class And
+  def it
+    highlights(:code)
+  end
+end
+\```
+
 #
 
 Headers can also be blank

data/lib/string.rb

@@ -1,6 +1,6 @@
 class String
   def wrap(width)
-    self.split("\n").collect { |line|
+    split("\n").collect { |line|
       if line.length > width
         line.gsub(/(.{1,#{width}})(\s+|$)/, "\\1\n").strip
       else

data/lib/tp.rb

@@ -1,10 +1,15 @@
+require 'coderay'
+
 require 'keyboard'
 require 'screen'
 require 'string'
-
 require 'tp/presenter'
 require 'tp/renderer'
 require 'tp/slide'
+require 'tp/slide/bulleted'
+require 'tp/slide/code'
+require 'tp/slide/header_only'
+require 'tp/slide/paragraph'
 require 'tp/slide_deck'
+require 'tp/slide_factory'
 require 'tp/version'
-

data/lib/tp/presenter.rb

@@ -1,9 +1,9 @@
 module TP
   class Presenter
-    attr_accessor :markdown
+    attr_reader :markdown
 
     def initialize(markdown)
-      self.markdown = markdown
+      @markdown = markdown
     end
 
     def present
@@ -33,7 +33,7 @@ module TP
       result.reject! &:empty?
       result.map! { |string| string.prepend "#" }
 
-      result.map { |string| Slide.new string }
+      result.map { |string| SlideFactory.from_markdown string }
     end
 
     def slide_deck

data/lib/tp/renderer.rb

@@ -1,36 +1,23 @@
 module TP
   class Renderer
-    BULLET = "\u2022 "
+    attr_reader :text
 
-    attr_accessor :slide
-
-    def initialize(slide)
-      self.slide = slide
+    def initialize(text)
+      @text = text
     end
 
     def render
       Screen.clear!
 
-      return unless slide
-
-      buffer = slide.header.center Screen.width
-
-      if slide.body
-        buffer << "\n\n"
-
-        if slide.paragraph
-          paragraph = slide.paragraph.wrap Screen.width
-          paragraph = paragraph.center Screen.width if paragraph.lines.one?
+      return unless text
 
-          buffer << paragraph
-        else
-          slide.bullets.each { |string| buffer << "#{BULLET}#{string}\n" }
-        end
-      end
-
-      print buffer unless ENV['RUBY_ENV'] == 'test'
+      print text unless testing?
 
       true
     end
+
+    def testing?
+      ENV['RUBY_ENV'] == 'test'
+    end
   end
 end

data/lib/tp/slide.rb

@@ -1,9 +1,9 @@
 module TP
   class Slide
-    attr_accessor :markdown
+    attr_reader :markdown
 
     def initialize(markdown)
-      self.markdown = markdown.strip
+      @markdown = markdown.strip
     end
 
     def header
@@ -11,40 +11,34 @@ module TP
       line[1, line.length - 1].to_s.strip
     end
 
-    def body
+    def centered_header
+      header.center Screen.width
+    end
+
+    def content
       result = lines[2, lines.count - 2]
 
-      result.join "" if result
+      result.join if result
     end
 
-    def bullets
-      return unless body
-
-      result = body.scan(/^\*\s+(.+)/).flatten
+    def frames
+      [render]
+    end
 
-      result if result.any?
+    def lines
+      markdown.lines.to_a
     end
 
-    def paragraph
-      body unless bullets
+    def render
+      raise NotImplementedError
     end
 
     def width
-      return header.length unless body
-
-      (body.lines.to_a.collect(&:length) + [header.length]).max
+      raise NotImplementedError
     end
 
     def height
-      return 1 unless body
-
-      body.lines.count + 2
-    end
-
-    private
-
-    def lines
-      markdown.lines.to_a
+      lines.count
     end
   end
 end

data/lib/tp/slide/bulleted.rb

@@ -0,0 +1,33 @@
+class TP::Slide::Bulleted < TP::Slide
+  BULLET = "\u2022 "
+
+  def render
+    frames.last
+  end
+
+  def width
+    header_length = header.length
+    longest_bullet = bullets.collect(&:length).max + 2
+    [header_length, longest_bullet].max
+  end
+
+  def bullets
+    content.lines.to_a.map { |line| line.gsub(/^\*\s/, "").strip }
+  end
+
+  def frames
+    return @frames if @frames
+
+    buffer = centered_header
+    buffer << "\n\n"
+
+    @frames = [buffer.dup]
+
+    bullets.each do |bullet|
+      buffer << "#{BULLET} #{bullet}\n"
+      @frames << buffer.dup
+    end
+
+    @frames
+  end
+end

data/lib/tp/slide/code.rb

@@ -0,0 +1,40 @@
+class TP::Slide::Code < TP::Slide
+  def render
+    centered_header +
+      "\n\n" +
+      highlighted_code
+  end
+
+  def height
+    code.lines.count + 2
+  end
+
+  def width
+    lines.collect { |line| line.rstrip.length }.max
+  end
+
+  def code
+    content.lines.to_a.reject { |line| line.start_with? "```" }.join
+  end
+
+  def highlighted_code
+    CodeRay.encode(code, language, :terminal)
+  end
+
+  def raw_language
+    match = lines[2].match(/^\`{3}(\w+)/)
+
+    match[1] if match
+  end
+
+  def language
+    case raw_language
+    when nil then "text"
+    when "clj" then "clojure"
+    when "objc" then "cpp"
+    when "rb" then "ruby"
+    else
+      raw_language
+    end
+  end
+end

data/lib/tp/slide/header_only.rb

@@ -0,0 +1,9 @@
+class TP::Slide::HeaderOnly < TP::Slide
+  def render
+    centered_header
+  end
+
+  def width
+    header.length
+  end
+end

data/lib/tp/slide/paragraph.rb

@@ -0,0 +1,18 @@
+class TP::Slide::Paragraph < TP::Slide
+  def render
+    centered_header +
+      "\n\n" +
+      paragraph
+  end
+
+  def paragraph
+    buffer = content.wrap Screen.width
+    buffer = buffer.center Screen.width if buffer.lines.one?
+
+    buffer
+  end
+
+  def width
+    content.length
+  end
+end

data/lib/tp/slide_deck.rb

@@ -1,10 +1,10 @@
 module TP
   class SlideDeck
-    attr_accessor :cursor, :slides
+    attr_reader :cursor, :slides
 
     def initialize(slides)
-      self.cursor = 0
-      self.slides = slides
+      @cursor = 0
+      @slides = slides
     end
 
     def [](index)
@@ -26,39 +26,26 @@ module TP
       @frames = []
 
       slides.each do |slide|
-        if slide.bullets
-          buffer = "# #{slide.header}"
-
-          @frames << Slide.new(buffer)
-
-          buffer << "\n"
-
-          slide.bullets.each do |bullet|
-            buffer << "\n* #{bullet}"
-            @frames << Slide.new(buffer)
-          end
-        else
-          @frames << Slide.new("# #{slide.header}\n\n#{slide.body}")
-        end
+        @frames |= slide.frames
       end
 
       @frames
     end
 
     def next
-      self.cursor += 1
+      @cursor += 1
 
       current
     end
 
     def previous
-      self.cursor -= 1
+      @cursor -= 1
 
       current
     end
 
     def width
-      slides_without_paragraphs = slides.reject(&:paragraph)
+      slides_without_paragraphs = slides.reject { |slide| slide.class == TP::Slide::Paragraph }
 
       if slides_without_paragraphs.empty?
         [slides.collect(&:width).max, 80].min

data/lib/tp/slide_factory.rb

@@ -0,0 +1,20 @@
+module TP
+  class SlideFactory
+    def self.from_markdown(markdown)
+      lines = markdown.lines.to_a
+
+      return Slide::HeaderOnly.new markdown if lines.count < 3
+
+      content = lines[2, lines.count - 2].join
+
+      case content.lines.first
+      when /^\*\s/
+        Slide::Bulleted.new markdown
+      when /^\`{3}/
+        Slide::Code.new markdown
+      else
+        Slide::Paragraph.new markdown
+      end
+    end
+  end
+end

data/lib/tp/version.rb

@@ -1,3 +1,3 @@
 module TP
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/slides.md

@@ -6,7 +6,7 @@ Terminal Presenter
 
 # tp
 
-Presents Markdown in your terminal
+Presents Markdown slides in your terminal
 
 # Installation
 
@@ -38,6 +38,16 @@ There can also be...
 
 ...multiple paragraphs.
 
+# Code
+
+```rb
+class And
+  def it
+    highlights(:code)
+  end
+end
+```
+
 #
 
 Headers can also be blank

data/spec/lib/tp/slide/bulleted_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe TP::Slide::Bulleted do
+  subject { slide }
+
+  let(:markdown) { "# Bullets\n\n* Bullet 1\n* Bullet 2" }
+  let(:slide) { klass.new markdown }
+
+  before do
+    Screen.stub width: 20
+  end
+
+  its(:width) { should == 10 }
+  its(:height) { should == 4 }
+
+  describe "#render" do
+    subject(:lines) { slide.render.lines.to_a }
+
+    it { lines.count.should == 4 }
+
+    it "centers the header" do
+      lines[0].should == "Bullets".center(20) + "\n"
+    end
+
+    it "renders bullets" do
+      lines[2].should == "#{TP::Slide::Bulleted::BULLET} Bullet 1\n"
+      lines[3].should == "#{TP::Slide::Bulleted::BULLET} Bullet 2\n"
+    end
+  end
+
+  describe "#frames" do
+    subject(:frames) { slide.frames }
+
+    its(:count) { should == 3 }
+
+    it "incrementally shows bullets" do
+      frames[0].should == "Bullets".center(20) + "\n\n"
+
+      frames[1].should == "Bullets".center(20) + "\n\n" +
+        "#{TP::Slide::Bulleted::BULLET} Bullet 1\n"
+
+      frames[2].should == "Bullets".center(20) + "\n\n" +
+        "#{TP::Slide::Bulleted::BULLET} Bullet 1\n" +
+        "#{TP::Slide::Bulleted::BULLET} Bullet 2\n"
+    end
+  end
+end

data/spec/lib/tp/slide/code_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe TP::Slide::Code do
+  subject { slide }
+
+  let(:markdown) { "# Code\n\n```rb\nclass Thing\nend\n```" }
+  let(:slide) { klass.new markdown }
+
+  before do
+    Screen.stub width: 20
+  end
+
+  its(:width) { should == 11 }
+  its(:height) { should == 4 }
+
+  its(:code) { should == "class Thing\nend\n" }
+  its(:language) { should == "ruby" }
+
+  describe "#highlighted_code" do
+    subject(:highlighted_code) { slide.highlighted_code }
+
+    it "uses CodeRay" do
+      CodeRay.should_receive(:encode).with("class Thing\nend\n", "ruby", :terminal)
+
+      highlighted_code
+    end
+
+    context "with no language" do
+      let(:markdown) { "# Code\n\n```\nThis is a code block\n```" }
+
+      it "doesn't raise an error" do
+        highlighted_code
+      end
+    end
+  end
+
+  describe "#render" do
+    subject(:render) { slide.render }
+
+    before do
+      slide.stub highlighted_code: "Highlighted code"
+    end
+
+    it { should == "Code".center(20) + "\n\n" + "Highlighted code" }
+  end
+end

data/spec/lib/tp/slide/header_only_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe TP::Slide::HeaderOnly do
+  subject { slide }
+
+  let(:markdown) { "# Header" }
+  let(:slide) { klass.new markdown }
+
+  before do
+    Screen.stub width: 20
+  end
+
+  its(:width) { should == 6 }
+  its(:height) { should == 1 }
+
+  describe "#render" do
+    subject(:lines) { slide.render.lines.to_a }
+
+    it { lines.count.should == 1 }
+
+    it "centers the header" do
+      lines[0].should == "Header".center(20)
+    end
+  end
+end

data/spec/lib/tp/slide/paragraph_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe TP::Slide::Paragraph do
+  subject { slide }
+
+  let(:markdown) { "# Paragraph\n\nShort paragraph" }
+  let(:slide) { klass.new markdown }
+
+  before do
+    Screen.stub width: 20
+  end
+
+  its(:width) { should == 15 }
+  its(:height) { should == 3 }
+
+  describe "#render" do
+    subject(:lines) { slide.render.lines.to_a }
+
+    it { lines.count.should == 3 }
+
+    it "centers the header" do
+      lines[0].should == "Paragraph".center(20) + "\n"
+    end
+
+    it "centers short paragraphs" do
+      lines[2].should == "Short paragraph".center(20)
+    end
+
+    context "with long paragraphs" do
+      let(:markdown) { "# Paragraph\n\nThis is a very long paragraph" }
+
+      it "wraps" do
+        lines[2].should == "This is a very long\n"
+        lines[3].should == "paragraph"
+      end
+    end
+  end
+end

data/spec/lib/tp/slide_deck_spec.rb

@@ -5,8 +5,8 @@ describe TP::SlideDeck do
 
   let(:slides) {
     [
-      TP::Slide.new("# First Slide\n\n* Bullet 1\n* Bullet 2"),
-      TP::Slide.new("# Second Slide\n\nThis is a paragraph")
+      TP::SlideFactory.from_markdown("# First Slide\n\n* Bullet 1\n* Bullet 2"),
+      TP::SlideFactory.from_markdown("# Second Slide\n\nThis is a paragraph")
     ]
   }
 
@@ -15,7 +15,7 @@ describe TP::SlideDeck do
 
   context "with only really long paragraphs" do
     let (:slides) {
-      [TP::Slide.new("# First Slide\n\n#{'word ' * 100}")]
+      [TP::SlideFactory.from_markdown("# First Slide\n\n#{'word ' * 100}")]
     }
 
     its(:width) { should == 80 }

data/spec/lib/tp/slide_factory_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe TP::SlideFactory do
+  describe ".from_markdown" do
+    subject(:from_markdown) { klass.from_markdown markdown }
+
+    context "with only a header" do
+      let(:markdown) { "# Header" }
+
+      it { should be_a TP::Slide::HeaderOnly }
+    end
+
+    context "with a paragraph" do
+      let(:markdown) { "# Paragraph\n\nThis is a paragraph" }
+
+      it { should be_a TP::Slide::Paragraph }
+    end
+
+    context "with bullets" do
+      let(:markdown) { "# Bullets\n\n* Bullet" }
+
+      it { should be_a TP::Slide::Bulleted }
+    end
+
+    context "with a code block" do
+      let(:markdown) { "# Code\n\n```rb\n:test\n```" }
+
+      it { should be_a TP::Slide::Code }
+    end
+  end
+end

data/spec/lib/tp/slide_spec.rb

@@ -4,86 +4,11 @@ describe TP::Slide do
   subject(:slide) { klass.new markdown }
 
   let(:markdown) {
-    "# First Slide\n\n* Bullet 1\n* Bullet 2"
+    "# First Slide\n\nThis is a slide with a paragraph"
   }
 
   its(:markdown) { should == markdown }
 
-  context "with bullets" do
-    let(:markdown) {
-      "# First Slide\n\n* Bullet 1\n* Bullet 2"
-    }
-
-    its(:header) { should == "First Slide" }
-    its(:body) { should == "* Bullet 1\n* Bullet 2" }
-
-    its(:bullets) { should =~ ["Bullet 1", "Bullet 2"] }
-    its(:paragraph) { should be_nil }
-
-    its(:width) { should == 11 }
-    its(:height) { should == 4 }
-  end
-
-  context "with a paragraph" do
-    let(:markdown) {
-      "# First Slide\n\nThis is a paragraph of text"
-    }
-
-    its(:header) { should == "First Slide" }
-    its(:body) { should == "This is a paragraph of text" }
-
-    its(:bullets) { should be_nil }
-    its(:paragraph) { should == "This is a paragraph of text" }
-
-    its(:width) { should == 27 }
-    its(:height) { should == 3 }
-  end
-
-  context "with just a header" do
-    let(:markdown) {
-      "# First Slide"
-    }
-
-    its(:header) { should == "First Slide" }
-    its(:body) { should be_nil }
-
-    its(:bullets) { should be_nil }
-    its(:paragraph) { should be_nil }
-
-    its(:width) { should == 11 }
-    its(:height) { should == 1 }
-  end
-
-  context "with a header longer than the paragraph" do
-    let(:markdown) {
-      "# This is a very long header\n\nand short paragraph"
-    }
-
-    its(:width) { should == 26 }
-  end
-
-  context "with a blank header" do
-    let(:markdown) {
-      "#\n\nFirst Slide"
-    }
-
-    its(:header) { should be_empty }
-    its(:body) { should == "First Slide" }
-
-    its(:bullets) { should be_nil }
-    its(:paragraph) { should == "First Slide" }
-
-    its(:width) { should == 11 }
-    its(:height) { should == 3 }
-  end
-
-  context "with trailing newlines" do
-    let(:markdown) {
-      "# First Slide\n\n* Bullet 1\n* Bullet 2\n\n"
-    }
-
-    it "strips whitespace" do
-      slide.markdown.should == "# First Slide\n\n* Bullet 1\n* Bullet 2"
-    end
-  end
+  its(:header) { should == "First Slide" }
+  its(:content) { should == "This is a slide with a paragraph" }
 end

data/tp.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |gem|
   gem.version       = TP::VERSION
   gem.authors       = ["Justin Campbell"]
   gem.email         = ["justin@justincampbell.me"]
-  gem.description   = "tp"
-  gem.summary       = "tp"
+  gem.summary       = "Terminal Presenter"
+  gem.description   = "Presents Markdown slides in your terminal"
   gem.homepage      = "http://github.com/justincampbell/tp"
 
   gem.files         = `git ls-files`.split $/
@@ -19,6 +19,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_dependency "coderay"
+
   gem.add_development_dependency "guard-rspec"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tp
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,6 +11,22 @@ bindir: bin
 cert_chain: []
 date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +91,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: tp
+description: Presents Markdown slides in your terminal
 email:
 - justin@justincampbell.me
 executables:
@@ -99,14 +115,24 @@ files:
 - lib/tp/presenter.rb
 - lib/tp/renderer.rb
 - lib/tp/slide.rb
+- lib/tp/slide/bulleted.rb
+- lib/tp/slide/code.rb
+- lib/tp/slide/header_only.rb
+- lib/tp/slide/paragraph.rb
 - lib/tp/slide_deck.rb
+- lib/tp/slide_factory.rb
 - lib/tp/version.rb
 - slides.md
 - spec/lib/keyboard_spec.rb
 - spec/lib/screen_spec.rb
 - spec/lib/string_spec.rb
 - spec/lib/tp/presenter_spec.rb
+- spec/lib/tp/slide/bulleted_spec.rb
+- spec/lib/tp/slide/code_spec.rb
+- spec/lib/tp/slide/header_only_spec.rb
+- spec/lib/tp/slide/paragraph_spec.rb
 - spec/lib/tp/slide_deck_spec.rb
+- spec/lib/tp/slide_factory_spec.rb
 - spec/lib/tp/slide_spec.rb
 - spec/lib/tp_spec.rb
 - spec/spec_helper.rb
@@ -135,13 +161,18 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: tp
+summary: Terminal Presenter
 test_files:
 - spec/lib/keyboard_spec.rb
 - spec/lib/screen_spec.rb
 - spec/lib/string_spec.rb
 - spec/lib/tp/presenter_spec.rb
+- spec/lib/tp/slide/bulleted_spec.rb
+- spec/lib/tp/slide/code_spec.rb
+- spec/lib/tp/slide/header_only_spec.rb
+- spec/lib/tp/slide/paragraph_spec.rb
 - spec/lib/tp/slide_deck_spec.rb
+- spec/lib/tp/slide_factory_spec.rb
 - spec/lib/tp/slide_spec.rb
 - spec/lib/tp_spec.rb
 - spec/spec_helper.rb