termnote 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p286@termnote"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.16.17 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kurtis Rainbolt-Greene
+
+MIT License
+
+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,74 @@
+TermNote
+--------
+
+TermNote is a program that allows you to write presentations either in Ruby:
+
+``` ruby
+require 'termnote'
+
+include TermNote
+
+show.add chapter title: "Hello, World"
+show.add code language: "Ruby", source: <<-SOURCE
+  puts "Hello, world!"
+SOURCE
+show.start
+```
+Or via a `.yaml` file:
+
+``` yaml
+---
+type: chapter
+title: Hello, World
+subtitle: By Kurtis
+---
+type: code
+source: |
+  puts "Hello, world!"
+```
+
+and then with the `termnote` binary:
+
+``` shell
+$ termnote someshow.yml
+```
+
+Here's an example of the slides in use:
+
+![Chapter](https://raw.github.com/krainboltgreene/termnote/master/example/chapter.png)
+![Text](https://raw.github.com/krainboltgreene/termnote/master/example/text.png)
+![List](https://raw.github.com/krainboltgreene/termnote/master/example/list.png)
+![Code](https://raw.github.com/krainboltgreene/termnote/master/example/code.png)
+
+You can then use **j** or **k** to navigate through the slides.
+
+Installation
+============
+
+Install it yourself via:
+
+    $ gem install termnote
+
+
+Usage
+=====
+
+Usage is pretty simple, there are 4 types of slides:
+
+  * Chapter, a single `title` [optional: and `subtitle`]
+  * Text, a blob of text called `content` [optional: and `title`]
+  * List, a list of `items` [optional: and `title`]
+  * Code, a syntax highlighted blob called `source`
+
+You can change the way things are printed out by overriding the classes for
+your specific presentation, but only if you do things programatically.
+
+
+Contributing
+============
+
+  1. Fork it
+  2. Create your feature branch (`git checkout -b my-new-feature`)
+  3. Commit your changes (`git commit -am 'Add some feature'`)
+  4. Push to the branch (`git push origin my-new-feature`)
+  5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'rake/testtask'
+require 'yard'
+
+begin
+  Bundler.setup :default, :development
+rescue Bundler::BundlerError => error
+  $stderr.puts error.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit error.status_code
+end
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all of the tests"
+Rake::TestTask.new do |config|
+  config.libs << 'test'
+  config.pattern = 'test/**/*_test*'
+  config.verbose = true
+  config.warning = true
+end
+
+desc "Generate all of the docs"
+YARD::Rake::YardocTask.new do |config|
+  config.files = Dir['lib/**/*.rb']
+end
+
+desc 'Default: run tests, and generate docs'
+task :default => [ :test, :yard ]

data/bin/termnote

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'termnote'
+require 'termnote/loader'
+
+include TermNote
+
+file = File.read ARGV.first
+
+TermNote::Loader.new(file).to_panes.each { |pane| show.add pane }
+
+show.start

data/example/slideshow1.yaml

@@ -0,0 +1,33 @@
+---
+type: chapter
+title: How To Learn
+subtitle: A Presentation By Kurtis
+---
+type: text
+title: Find Inspiration
+content: |
+  Anyone who stops learning is old, whether
+  at twenty or eighty. Anyone who keeps
+  learning stays young. The greatest
+  thing in life is to keep your mind
+  young.
+
+  -- Henry Ford
+---
+type: list
+title: Materials
+items:
+  - Paper
+  - Pencil
+  - Heart
+---
+type: code
+language: ruby
+source: |
+  # Some random code here
+  puts 'Hello, world!'
+  name + nom
+  function(full)
+  class Foo < Far
+    :sum
+  end

data/lib/termnote/loader.rb

@@ -0,0 +1,25 @@
+module TermNote
+  class Loader
+    attr_accessor :document
+
+    def initialize(file)
+      if YAML.parse(file)
+        @documents = YAML.load_stream(file)
+      else
+        raise "not a yaml file?"
+      end
+    end
+
+    def to_panes
+      @documents.map do |document|
+        type = document['type']
+        case type
+          when "chapter" then Pane::Chapter.new document
+          when "code" then Pane::Code.new document
+          when "list" then Pane::List.new document
+          when "text" then Pane::Text.new document
+        end
+      end
+    end
+  end
+end

data/lib/termnote/pane/chapter.rb

@@ -0,0 +1,36 @@
+module TermNote
+  module Pane
+    class Chapter
+      include Pane
+
+      attr_accessor :title, :subtitle
+
+      def initialize(options)
+        @title = options[:title] || options['title']
+        @subtitle = options[:subtitle] || options['subtitle']
+      end
+
+      def rows
+        if subtitle
+          title_rows + subtitle_rows
+        else
+          title_rows
+        end
+      end
+
+      private
+
+      def title_rows
+        title.split('').each_slice(80).map do |row|
+          row.join.center(width).bold
+        end
+      end
+
+      def subtitle_rows
+        subtitle.split('').each_slice(80).map do |row|
+          row.join.center(width)
+        end
+      end
+    end
+  end
+end

data/lib/termnote/pane/code.rb

@@ -0,0 +1,24 @@
+module TermNote
+  module Pane
+    class Code
+      include Pane
+
+      attr_accessor :source, :language
+
+      def initialize(options)
+        @source = options[:source] || options['source']
+        @language = options[:language] || options['language']
+      end
+
+      def rows
+        highlighted.split("\n")
+      end
+
+      private
+
+      def highlighted
+        Pygments.highlight source, formatter: 'terminal256', lexer: language
+      end
+    end
+  end
+end

data/lib/termnote/pane/list.rb

@@ -0,0 +1,22 @@
+module TermNote
+  module Pane
+    class List
+      include Pane
+
+      attr_accessor :title, :items
+
+      def initialize(options)
+        @title = options[:title] || options['title']
+        @items = options[:items] || options['items']
+      end
+
+      def rows
+        items.map { |item| "* #{item}" }.unshift title.bold + "\n"
+      end
+
+      def gutter
+        " " * (width * 0.5)
+      end
+    end
+  end
+end

data/lib/termnote/pane/text.rb

@@ -0,0 +1,20 @@
+module TermNote
+  module Pane
+    class Text
+      include Pane
+
+      attr_accessor :title, :content
+
+      def initialize(options)
+        @title = options[:title] || options['title']
+        @content = options[:content] || options['content']
+      end
+
+      def rows
+        "#{title.center(width).bold}\n\n#{content}".split("\n").map do |row|
+          row.center(width)
+        end
+      end
+    end
+  end
+end

data/lib/termnote/pane.rb

@@ -0,0 +1,43 @@
+require_relative 'pane/chapter'
+require_relative 'pane/code'
+require_relative 'pane/list'
+require_relative 'pane/text'
+module TermNote
+  module Pane
+    attr_accessor :show, :height, :width, :rows
+
+    def call(window_size)
+      window_height, window_width = window_size
+      @width = window_width - (window_width * 0.2)
+      @height = window_height / 2
+      clear
+      render
+    end
+
+    private
+
+    def clear
+      system("clear")
+    end
+
+    def render
+      puts space + formated_rows + space + footer
+    end
+
+    def gutter
+      " " * (width * 0.1)
+    end
+
+    def space
+      "\n" * (height - rows.size)
+    end
+
+    def footer
+      "[#{show.panes.index(self) + 1}/#{show.panes.size}]".bold
+    end
+
+    def formated_rows
+      rows.map { |row| gutter + row }.join("\n")
+    end
+  end
+end

data/lib/termnote/show.rb

@@ -0,0 +1,46 @@
+module TermNote
+  class Show
+    attr_accessor :panes
+
+    def initialize
+      @panes = []
+    end
+
+    def add(pane)
+      panes << pane
+      pane.show = self
+    end
+
+    def pane
+      @pane || panes.first
+    end
+
+    def position
+      panes.index pane
+    end
+
+    def start
+      active = true
+      while active
+        pane.call $stdout.winsize
+        case command
+          when "j" then forward
+          when "k" then backward
+          when "q" then active = false
+        end
+      end
+    end
+
+    def forward
+      @pane = panes[position + 1] || panes.first
+    end
+
+    def backward
+      @pane = panes[position - 1] || panes.last
+    end
+
+    def command
+      $stdin.getch
+    end
+  end
+end

data/lib/termnote/version.rb

@@ -0,0 +1,3 @@
+module TermNote
+  VERSION = "1.0.0"
+end

data/lib/termnote.rb

@@ -0,0 +1,31 @@
+require 'io/console'
+require 'colored'
+require 'pygments'
+require 'yaml'
+require_relative 'termnote/version'
+require_relative 'termnote/pane'
+require_relative 'termnote/show'
+require_relative 'termnote/pane'
+
+module TermNote
+  def show
+    @show ||= Show.new
+  end
+
+  def chapter(options)
+    Pane::Chapter.new options
+  end
+
+  def text(options)
+    Pane::Text.new options
+  end
+
+  def code(options)
+    Pane::Code.new options
+  end
+
+  def list(options)
+    Pane::List.new options
+  end
+end
+

data/termnote.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'termnote/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "termnote"
+  gem.version       = TermNote::VERSION
+  gem.authors       = ["Kurtis Rainbolt-Greene"]
+  gem.email         = ["me@kurtisrainboltgreene.name"]
+  gem.summary       = %q{A terminal based keynote presentation machine}
+  gem.description   = gem.summary
+  gem.homepage      = "http://krainboltgreene.github.com/termnote"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'colored', '~> 1.2'
+  gem.add_runtime_dependency 'pygments.rb', '~> 0.3'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'kramdown'
+  # gem.add_runtime_dependency 'gemname', '~> 1.0'
+  # gem.add_development_dependency 'gemname', '~> 1.0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: termnote
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A terminal based keynote presentation machine
+email:
+- me@kurtisrainboltgreene.name
+executables:
+- termnote
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/termnote
+- example/chapter.png
+- example/code.png
+- example/list.png
+- example/running.png
+- example/slideshow1.yaml
+- example/text.png
+- lib/termnote.rb
+- lib/termnote/loader.rb
+- lib/termnote/pane.rb
+- lib/termnote/pane/chapter.rb
+- lib/termnote/pane/code.rb
+- lib/termnote/pane/list.rb
+- lib/termnote/pane/text.rb
+- lib/termnote/show.rb
+- lib/termnote/version.rb
+- termnote.gemspec
+homepage: http://krainboltgreene.github.com/termnote
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1621899467072845328
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1621899467072845328
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A terminal based keynote presentation machine
+test_files: []
+has_rdoc: