termistat 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+pkg/*
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    termistat (0.0.1)
+      ffi-ncurses
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ffi (1.0.9)
+    ffi-ncurses (0.3.3)
+      ffi (>= 0.6.3)
+    rake (0.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  termistat!

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2011 Solomon White
+
+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,111 @@
+# Termistat
+
+Termistat displays an ncurses-based status bar atop your STDOUT.
+
+## Scenario:
+
+You have a long-running process that writes detailed log information to
+standard output.  You would like to also be able to determine overall
+progress at a glance.  You could scatter status lines among the log
+lines, but that's messy and can be hard to find.  You could ditch the
+detail output and display status only, but then you lose the sense of
+what's going on at the detail level.
+
+## The Solution
+
+Termistat gives you the best of both worlds.  You still have your
+detailed information, but you also have a status bar overlay with which
+you can display summary information.
+
+## Screenshot
+
+Here's what termistat looks like in action:
+
+![screenshot](https://github.com/rubysolo/termistat/raw/master/examples/file_copy.png)
+
+
+## Installation:
+
+    gem install termistat
+
+## Usage:
+
+Include the module in your class, and you get a `status_bar` method.
+
+    class VerboseProcess
+      include Termistat
+
+      def perform
+        1000.times do |index|
+          status_bar progress(index / 1000.0)
+          $stdout.puts "This is normal log entry number #{ index }"
+
+          # do some hard work
+          sleep(rand(10))
+        end
+      end
+
+      def progress(pct)
+        "status: %0.2f% complete" % (pct * 100)
+      end
+    end
+
+Don't want to or can't include?  No problem, you can use the module
+method.
+
+    class VerboseProcess
+      def perform
+        1000.times do |index|
+          Termistat.status_bar progress(index / 1000.0)
+          $stdout.puts "This is normal log entry number #{ index }"
+
+          # do some hard work
+          sleep(rand(10))
+        end
+      end
+
+      def progress(pct)
+        "status: %0.2f complete" % pct
+      end
+    end
+
+## Configuration:
+
+Termistat provides a default configuration that will display your status
+bar in the top right corner of your terminal.  Using the configuration
+DSL, you can customize the status bar to your liking.
+
+    Termistat.config do
+      position   :top
+      align      :center
+      background :black
+      foreground :magenta
+    end
+
+## Requirements
+
+* ffi-ncurses gem
+* ncurses (tested with homebrew-installed ncurses)
+
+## License
+
+The MIT License (MIT)
+Copyright (c) 2011 Solomon White
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new('test') do |t|
+  t.pattern = 'test/**/test_*.rb'
+  t.warning = true
+end
+
+task :default => :test
+

data/examples/file_copy.rb

@@ -0,0 +1,17 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'termistat'
+
+class FileCopy
+  include Termistat
+
+  def simulate
+    ('a'..'z').to_a.each_with_index do |letter, index|
+      status_bar("%0.1f%% complete" % ((index / 26.to_f) * 100))
+      puts "copying /path/to/file/#{ letter }..."
+      sleep rand(0.5)
+    end
+  end
+end
+
+fc = FileCopy.new
+fc.simulate

data/lib/termistat.rb

@@ -0,0 +1,146 @@
+require 'termistat/config'
+require 'termistat/tee_io'
+require 'termistat/version'
+
+begin
+  require 'ffi-ncurses'
+rescue LoadError
+  require 'rubygems'
+  require 'ffi-ncurses'
+end
+
+#
+# Termistat is a status bar for your terminal
+#
+# :title:Termistat
+
+module Termistat
+  #
+  # The +status_bar+ instance method initializes the status bar if necessary
+  # and displays your message.
+  #
+  # === Parameters
+  # * message = the messge you want to display
+  #
+  # === Example
+  #  include Termistat
+  #  status_bar "37% complete"
+  #
+  def status_bar(message)
+    Termistat.status_bar message
+  end
+
+  class << self
+    #
+    # the +status_bar+ class method initializes the status bar if necessary
+    # and displays your message.
+    #
+    # === Parameters
+    # * message = the messge you want to display
+    #
+    # === Example
+    #  Termistat.status_bar "37% complete"
+    #
+    def status_bar(message)
+      setup unless @stdscr
+      m = formatted_message(message, config.align, status_bar_width)
+
+      FFI::NCurses.wmove @status, 0, 0
+      FFI::NCurses.wattr_set @status, FFI::NCurses::A_NORMAL, 1, nil
+      FFI::NCurses.waddstr @status, m
+      FFI::NCurses.wrefresh @status
+    end
+
+    #
+    # +config+ either returns the active configuration or (when a block is
+    # passed), sets up the configuration DSL.  See Termistat::Config for
+    # supported parameters and options.
+    #
+    # === Example
+    #  Termistat.config do
+    #    align :left
+    #  end
+    #
+    def config(&block)
+      if block_given?
+        c = Config.new
+        c.instance_eval(&block)
+        @config = c
+      end
+
+      @config ||= Config.new
+    end
+
+    #:enddoc:
+    def config=(config)
+      @config = config
+    end
+
+    def setup
+      # set up ncurses standard screen
+      @stdscr = FFI::NCurses.initscr
+      FFI::NCurses.scrollok @stdscr, 1
+
+      # set up ncurses status bar
+      @height, @width = FFI::NCurses.getmaxyx(@stdscr)
+
+      @status = FFI::NCurses.newwin(*status_bar_params)
+      FFI::NCurses.scrollok @status, 0
+
+      # set up colors
+      FFI::NCurses.start_color
+      background = FFI::NCurses::Color.const_get(config.background.to_s.upcase)
+      foreground = FFI::NCurses::Color.const_get(config.foreground.to_s.upcase)
+      FFI::NCurses.init_pair(1, foreground, background)
+
+      # hide cursor
+      FFI::NCurses.curs_set 0
+
+      # redirect stdout
+      $stdout = TeeIO.new do |msg|
+        FFI::NCurses.addstr msg
+        FFI::NCurses.refresh
+
+        FFI::NCurses.touchwin @status
+        FFI::NCurses.wrefresh @status
+      end
+
+      at_exit do
+        FFI::NCurses.endwin
+
+        output = $stdout.string
+        $stdout = STDOUT
+        puts output
+      end
+    end
+
+    def status_bar_params
+      case config.position
+      when Array
+        config.position
+      when :top
+        [1, @width, 0, 0]
+
+      when :top_right
+        x = @width / 2
+        w = @width - x
+        [1, w, 0, x]
+
+      when :top_left
+        x = @width / 2
+        w = @width - x
+        [1, w, 0, 0]
+
+      end
+    end
+
+    def status_bar_width
+      status_bar_params[1]
+    end
+
+    def formatted_message(string, alignment, width)
+      return string.center(width) if :center === alignment
+      "%#{ :left === alignment ? '-' : '' }#{ width }s" % string
+    end
+  end
+end

data/lib/termistat/config.rb

@@ -0,0 +1,77 @@
+module Termistat
+  #
+  # The configuration class and DSL for Termistat
+  #
+  class Config
+    def initialize(options={}) #:notnew:
+      @options = {
+        :position   => :top_right,
+        :align      => :left,
+        :foreground => :white,
+        :background => :blue,
+      }.merge(options)
+    end
+
+    #
+    # position of the status bar on the terminal
+    #
+    # === Supported Options
+    # * +:top_left+ : left half of top line
+    # * +:top+ : full top line
+    # * +:top_right+ : right half of top line
+    #
+    def position(position=nil)
+      @options[:position] = position unless position.nil?
+      @options[:position]
+    end
+
+    #
+    # alignment of text within the status bar
+    #
+    # === Supported Options
+    # * +:left+
+    # * +:center+
+    # * +:right+
+    #
+    def align(align=nil)
+      @options[:align] = align unless align.nil?
+      @options[:align]
+    end
+
+    #
+    # color of foreground (text)
+    #
+    # === Supported Options
+    # * +:black+
+    # * +:red+
+    # * +:green+
+    # * +:yellow+
+    # * +:blue+
+    # * +:magenta+
+    # * +:cyan+
+    # * +:white+
+    #
+    def foreground(color=nil)
+      @options[:foreground] = color unless color.nil?
+      @options[:foreground]
+    end
+
+    #
+    # color of background
+    #
+    # === Supported Options
+    # * +:black+
+    # * +:red+
+    # * +:green+
+    # * +:yellow+
+    # * +:blue+
+    # * +:magenta+
+    # * +:cyan+
+    # * +:white+
+    #
+    def background(color=nil)
+      @options[:background] = color unless color.nil?
+      @options[:background]
+    end
+  end
+end

data/lib/termistat/tee_io.rb

@@ -0,0 +1,30 @@
+require 'stringio'
+
+module Termistat
+  #
+  # TeeIO wraps a StringIO object such that writes to the IO can trigger events
+  # immediately, but the entirety of the string is available later.
+  #
+  # initialize method takes a block that will be called on every write.
+  #
+  class TeeIO < StringIO
+    # create a new TeeIO object
+    #
+    # == Example
+    #  $stdout = TeeIO.new {|str| STDOUT.puts str.reverse }
+    #
+    def initialize(&block)
+      @io = StringIO.new
+      @callback = block
+    end
+
+    def write(chars)
+      @io.write(chars)
+      @callback.call(chars)
+    end
+
+    def string
+      @io.string
+    end
+  end
+end

data/lib/termistat/version.rb

@@ -0,0 +1,3 @@
+module Termistat
+  VERSION = "0.0.1"
+end

data/termistat.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "termistat/version"
+
+Gem::Specification.new do |s|
+  s.name        = "termistat"
+  s.version     = Termistat::VERSION
+  s.authors     = ["Solomon White"]
+  s.email       = ["rubysolo@gmail.com"]
+  s.homepage    = "https://github.com/rubysolo/termistat"
+  s.summary     = %q{Terminal status bar}
+  s.description = %q{Display status bar overlay for summary information}
+
+  s.rubyforge_project = "termistat"
+
+  s.add_runtime_dependency "ffi-ncurses"
+  s.add_development_dependency "rake"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+$:.unshift File.expand_path('../../lib', __FILE__)

data/test/units/test_config.rb

@@ -0,0 +1,16 @@
+require_relative '../helper'
+require 'termistat/tee_io'
+
+class TestTeeIO < MiniTest::Unit::TestCase
+  def setup
+    @default = Termistat::Config.new
+    @custom  = Termistat::Config.new(
+      :position => :top_right,
+      :align    => :left,
+    )
+  end
+
+  def test_configuration
+    assert_equal :top_right, @default.position
+  end
+end

data/test/units/test_tee_io.rb

@@ -0,0 +1,17 @@
+require_relative '../helper'
+require 'termistat/tee_io'
+
+class TestTeeIO < MiniTest::Unit::TestCase
+  def test_callback
+    @capture = nil
+    @tee_io = Termistat::TeeIO.new {|msg| @capture = msg }
+    @tee_io.print "foo"
+    assert_equal "foo", @capture
+  end
+
+  def test_output_is_recorded
+    @tee_io = Termistat::TeeIO.new {|*args|}
+    @tee_io.puts "foo"
+    assert_equal "foo\n", @tee_io.string
+  end
+end

data/test/units/test_termistat.rb

@@ -0,0 +1,41 @@
+require_relative '../helper'
+require 'termistat'
+
+class Included
+  include Termistat
+end
+
+class TestTermistat < MiniTest::Unit::TestCase
+  def setup
+    Termistat.config = nil
+    @included = Included.new
+  end
+
+  def test_status_bar_method
+    assert @included.respond_to?(:status_bar)
+  end
+
+  def test_ncurses_initialization
+    # @included.status_bar "hello"
+  end
+
+  def test_default_configuration
+    assert_equal :top_right, Termistat.config.position
+  end
+
+  def test_configuration
+    Termistat.config do
+      position :top_left
+      align    :center
+    end
+
+    assert_equal :top_left, Termistat.config.position
+  end
+
+  def test_text_alignment
+    assert_equal "foo       ", Termistat.formatted_message("foo", :left, 10)
+    assert_equal "       foo", Termistat.formatted_message("foo", :right, 10)
+    assert_equal "   foo    ", Termistat.formatted_message("foo", :center, 10)
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: termistat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Solomon White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi-ncurses
+  requirement: &70307433171700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70307433171700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70307433171180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70307433171180
+description: Display status bar overlay for summary information
+email:
+- rubysolo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- examples/file_copy.png
+- examples/file_copy.rb
+- lib/termistat.rb
+- lib/termistat/config.rb
+- lib/termistat/tee_io.rb
+- lib/termistat/version.rb
+- termistat.gemspec
+- test/helper.rb
+- test/units/test_config.rb
+- test/units/test_tee_io.rb
+- test/units/test_termistat.rb
+homepage: https://github.com/rubysolo/termistat
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: termistat
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Terminal status bar
+test_files:
+- test/helper.rb
+- test/units/test_config.rb
+- test/units/test_tee_io.rb
+- test/units/test_termistat.rb