bash-visual 1.0.5 → 1.0.6

data/.gitignore

@@ -1,3 +1,5 @@
 *~
 .gitignore
 .idea
+Gemfile.lock
+.coverage

data/Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bash-visual.gemspec
 gemspec
+
+group :test do
+  gem 'test-unit'
+  gem 'mocha', :group => :test, :require=>false
+  gem 'minitest-reporters'
+
+  gem 'simplecov', :require => false, :group => :test
+end

data/README.md

@@ -1,6 +1,17 @@
-# Bash::Visual
+# Bash-Visual
 
-Bash visualisation tools
+Bash visualisation library
+
+## Description
+**BashVisual** simplifies Unix-console operation (bash, csh etc). It uses _tput_ and standard Unix-terminal facilities. It is also thread-safe.
+
+BashVisual allows:
+- control position, colors and text's form
+- draw graphical primitives (rectangle, window)
+- create dynamic scrolling objects
+- get window parameters (weight, height)
+
+[See the wiki!](https://github.com/AlmazKo/BashVisual/wiki)
 
 ## Installation
 
@@ -17,14 +28,20 @@ Or install it yourself as:
     $ gem install bash-visual
 
 ## Usage
+```ruby
+require 'bash-visual'
+include Bash_Visual
+
+border_font = Font.new(:std, :blue)
+main_color = Font.new(:bold, :green)
+
+console = Console.new(main_color)
+console.clear
 
-    include Bash_Visual;
-    font = Font.new(Font::STD, Font::LIGHT_BLUE)
-    console = Console.new(font)
-    console.clear()
-    console.draw_window(2, 2, 20, 5, 'Example', font, Console::BORDER_UTF_DOUBLE)
-    console.write_to_position(5, 3, 'Hello World!', Font.new(Font::BOLD, Font::LIGHT_GREEN))
-    console.position = [0, 8]
+console.draw_window(2, 2, 20, 5, 'Example', border_font, Console::BORDER_UTF_DOUBLE)
+console.write_to_position(5, 3, 'Hello World!')
+console.position = [0, 8]
+```
 
 ## Contributing
 

data/bash-visual.gemspec

@@ -1,16 +1,18 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'bash-visual/version'
 
-Dir[File.dirname(__FILE__) + '/lib/bash-visual/*.rb'].each {|file| require file }
 
 Gem::Specification.new do |gem|
   gem.name          = 'bash-visual'
   gem.author        = 'Alexander Suslov'
   gem.email         = ['a.s.suslov@gmail.com']
   gem.description   = %q{Bash visualisation tools}
-  gem.summary       = %q{Bash visualisation tools}
-  gem.homepage      = 'https://github.com/AlmazKo/BashConsole'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/AlmazKo/BashVisual'
 
   gem.files         = `git ls-files`.split($\)
+  gem.test_files    = `git ls-files -- {test}/*`.split($\)
   gem.require_paths = ['lib']
   gem.version       = Bash_Visual::VERSION
   gem.license       = 'MIT'

data/example/hello_world.rb

@@ -0,0 +1,14 @@
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'bash-visual'
+include Bash_Visual
+
+border_font = Font.new(:std, :blue)
+main_color = Font.new(:bold, :green)
+
+console = Console.new(main_color)
+console.clear
+
+console.draw_window(2, 2, 20, 5, 'Example', border_font, Console::BORDER_UTF_DOUBLE)
+console.write_to_position(5, 3, 'Hello World!')
+console.position = [0, 8]

data/example/random.rb

@@ -0,0 +1,9 @@
+$:.push File.expand_path('../../lib', __FILE__)
+require 'bash-visual'
+include Bash_Visual
+
+console = Console.new
+
+'Font random demonstration'.chars do |char|
+  console.write char, Font.new(:std, Font::rand_color(:black))
+end

data/example/spectrum.rb

@@ -0,0 +1,30 @@
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'bash-visual'
+include Bash_Visual
+
+colors = Font::COLORS
+types  = [:std, :bold, :underline, :blink,
+          [:bold, :underline], [:bold, :blink], [:underline, :blink],
+          [:bold, :underline, :blink]
+]
+
+console = Console.new
+console.clear
+
+console.write_ln 'Example "Spectrum":'
+
+types.each do |type|
+
+  colors.each do |color|
+    console.write('X', Font.new(type, color))
+  end
+
+  console.write ' '
+
+  colors.each do |color|
+    console.write('X', Font.new(type, :white, color))
+  end
+
+  console.write_ln ' ' + type.inspect
+end

data/lib/bash-visual/builder.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 module Bash_Visual
   class Builder
 
@@ -21,7 +23,7 @@ module Bash_Visual
       "\e[s"
     end
 
-    def set_position (x, y)
+    def set_position(x, y)
       "\e[#{y.to_i};#{x.to_i}H"
     end
 
@@ -40,7 +42,7 @@ module Bash_Visual
       bash
     end
 
-    def write_to_position (x, y, text, font = @default_font)
+    def write_to_position(x, y, text, font = @default_font)
       bash = ''
       bash << save_position()
       bash << move_position(x, y)
@@ -49,12 +51,12 @@ module Bash_Visual
       bash
     end
 
-    def write (text, font = @default_font)
+    def write(text, font = @default_font)
       font.to_bash + text + Font::RESET
     end
 
-    def write_ln (text, font = @default_font)
-      font.to_bash + text << "\n" << Font::RESET
+    def write_ln(text, font = @default_font)
+      font.to_bash + text.to_s + $/ + Font::RESET
     end
   end
 end

data/lib/bash-visual/console.rb

@@ -23,7 +23,7 @@ module Bash_Visual
     def initialize (font = Font.new, way_outnput = OUTPUT_WITHOUT_BLOCK, builder = Builder.new)
       @current_x = 0
       @current_y = 0
-      @font = font
+      @type = font
       @way_output = way_outnput
       @builder = builder
     end
@@ -42,15 +42,20 @@ module Bash_Visual
     # Записать что-то в определенной позиции, а потом вернуться на текущую
     # Если необходимо сохранить позицию после записи - используйте связку
     # move_position/position= и write
-    def write_to_position (x, y, text, font = @font)
+    def write_to_position (x, y, text, font = @type)
       print @builder.write_to_position(x, y, text, font)
     end
 
-    def write (text, font = @font)
+    def write (text, font = @type)
       print @builder.write(text, font)
     end
 
-    def write_ln (text, font = @font)
+    def write_ln (text = nil, font = @type)
+      if text.nil?
+        print $/
+        return
+      end
+
       print @builder.write_ln(text, font)
     end
 
@@ -121,7 +126,15 @@ module Bash_Visual
     end
 
     def font= font
-      @font = font
+      @type = font
+    end
+
+    def lines
+      `tput lines`
+    end
+
+    def cols
+      `tput cols`
     end
 
     private

data/lib/bash-visual/font.rb

@@ -1,92 +1,122 @@
 module Bash_Visual
   class Font
-    BLACK         = 0
-    RED           = 1
-    GREEN         = 2
-    BROWN         = 3
-    BLUE          = 4
-    MAGENTA       = 5
-    CYAN          = 6
-    LIGHT_GRAY    = 7
-
-    GRAY          = 10
-    LIGHT_RED     = 11
-    LIGHT_GREEN   = 12
-    YELLOW        = 13
-    LIGHT_BLUE    = 14
-    LIGHT_MAGENTA = 15
-    LIGHT_CYAN    = 16
-    WHITE         = 17
-
-    RESET = "\e[0m"
-
-    #types font
-    STD        = 0
-    BOLD       = 1
-    UNDERLINE  = 2
-    BLINK      = 4
-
-    attr_reader :font, :foreground, :background
-
-    def initialize (font = STD, foreground = WHITE, background = nil)
-      raise "not found color #{foreground}" unless (0..7).cover? foreground or (10..17).cover? foreground
-      @font, @foreground, @background = font, foreground, background
-
-      @bash_command = ''
-
-      @string = "<type=%s, foreground=%s, background=%s>" % [@font, @foreground, @background]
-      if font == STD
-        if foreground and foreground < 10
-          @bash_command << "\e[3#{foreground}m"
-        else
-          @bash_command << "\e[9#{foreground-10}m"
-        end
+
+    COLORS = [:black, :dark_red, :dark_green, :dark_yellow, :dark_blue, :dark_magenta, :dark_cyan, :grey,
+              :dark_grey, :red, :green, :yellow, :blue, :magenta, :cyan, :white]
+
+    TYPES = [:std, :bold, :underline, :blink]
+
+    @@colors_map = {
+        black:        0,
+        dark_red:     1,
+        dark_green:   2,
+        dark_yellow:  3,
+        dark_blue:    4,
+        dark_magenta: 5,
+        dark_cyan:    6,
+        grey:         7,
+        dark_grey:    10,
+        red:          11,
+        green:        12,
+        yellow:       13,
+        blue:         14,
+        magenta:      15,
+        cyan:         16,
+        white:        17
+    }
+
+    @@types_map = {
+        std:       0,
+        bold:      1,
+        underline: 4,
+        blink:     5
+    }
+
+    RESET     = "\e[0m"
+
+    attr_reader :types, :foreground, :background
+
+    def initialize(types = :std, foreground = :white, background = nil)
+
+      unless COLORS.include?(foreground)
+        raise "not found color #{foreground}"
       end
 
-      if font & BOLD != 0
-        if foreground < 10
-          @bash_command << "\e[1;3#{foreground}m"
-        else
-          @bash_command << "\e[1;9#{foreground-10}m"
-        end
+      @foreground, @background = foreground, background
+
+      @types = prepare_types types
+
+      sequence = []
+      @types.each do |type|
+        sequence << @@types_map[type]
       end
 
-      if font & UNDERLINE != 0
-        if foreground < 10
-          @bash_command << "\e[4;3#{foreground}m"
-        else
-          @bash_command << "\e[4;9#{foreground-10}m"
-        end
+      color_index = @@colors_map[@foreground]
+
+      sequence << if color_index < 10
+                    "3#{color_index}"
+                  else
+                    "9#{color_index - 10}"
+                  end
+
+      if @background
+        color_index = @@colors_map[@background]
+        sequence << if color_index < 10
+                      "4#{color_index}"
+                    else
+                      "10#{color_index - 10}"
+                    end
       end
 
-      if background.instance_of? Fixnum
-        if background < 10
-          @bash_command << "\e[4#{background}m"
+      @bash_command = "\e[#{sequence.join(';')}m"
+    end
+
+
+    # @return [Array]
+    def prepare_types(types)
+      case types
+        when Symbol then
+          [types]
+        when Array then
+          if types.size > 2
+            types.delete_if { |type| type == :std }
+          else
+            types
+          end
         else
-          @bash_command << "\e[10#{background-10}m"
-        end
+          raise "types must be Array or Symbol"
       end
-
     end
 
-    def to_bash
-      @bash_command
+    def inspect
+      "<Font types=%s, foreground=%s, background=%s>" %
+          [@types, @foreground, (@background ? @background : 'nil')]
     end
 
     def to_s
-      @string
+      @bash_command
     end
 
+    alias to_bash to_s
+
     class << self
+
+      # @param [Symbol] exclude_color
       def rand_color (exclude_color = nil)
-        color = rand(14)
-        color += 1 if color == exclude_color
-        color = 0 if color > 14
-        color += 3 if color > 7
-        color
-      end
-    end
+        color = rand(16)
+        color += 2 if color > 7
+
+        if color == @@colors_map[exclude_color]
+          color += 1
+          color = 0 if color > 17
+        end
 
+        @@colors_map.each do |name, code|
+          return name if code == color
+        end
 
+      end
     end
+
+  end
 end

data/lib/bash-visual/scroll.rb

@@ -9,6 +9,20 @@ module Bash_Visual
 
     attr_accessor :console
 
+
+    # @param [Hash] options
+    #
+    # options = {
+    #   coordinates: [x, y],
+    #   window_size: [width, height],
+    #   font: Font.new
+    #   start: Scroll::ENDING,
+    #   adapt_size_message: true,
+    #   prefix: -> { '>' }
+    #   separator: '-'
+    # }
+    #
+    #
     def initialize(options)
 
       @x, @y = options[:coordinates]
@@ -32,18 +46,21 @@ module Bash_Visual
       @is_wrap = true
       @start = options[:start] ? ENDING : BEGINNING
       @separator = options[:separator] ? options[:separator] : false
-      @font = options[:font] ? options[:font] : nil
+      @type = options[:type] ? options[:type] : nil
 
       @stack = []
-      @console = Console.new @font,Console::OUTPUT_STRING
+      @console = Console.new @type, Console::OUTPUT_STRING
       @mutex = Mutex.new
+      nil
     end
 
     def scroll(positions = 1, direction = @direction * positions)
 
     end
 
-    def add (message, font = @font)
+    # @param [String] message
+    # @param [Bash_Visual::Font] font
+    def add(message, font = @type)
 
       if @stack.size.zero?
         print @console.draw_rectangle(@x + 1, @y + 1, @area_width, @area_height, font)
@@ -51,13 +68,16 @@ module Bash_Visual
 
       @stack << {
         message: prefix() << message.to_s,
-           font: font
+           type: font
       }
 
       redraw()
       #@stack.slice!(-index, index)
+      nil
     end
 
+
+    # @param [Object] prefix
     def prefix= (prefix)
       @prefix = prefix
     end
@@ -77,9 +97,9 @@ module Bash_Visual
       @stack.reverse.each do |item|
 
         message = item[:message].dup.lines.to_a
-        font = item[:font]
+        font = item[:type]
         unless font.background
-          font = Font.new font.font, font.foreground, @font.background
+          font = Font.new font.type, font.foreground, @type.background
         end
 
         avail_area = print_message(message, font, avail_area)
@@ -89,7 +109,9 @@ module Bash_Visual
     end
 
     # сделать переносы в массиве строк
-    def rows_wrap! arr, max_len
+    # @param [String] arr
+    # @param [Integer] max_len
+    def rows_wrap!(arr, max_len)
       max_used_len = 1
       arr.each_with_index do |row, i|
         len = row.size
@@ -101,9 +123,11 @@ module Bash_Visual
       max_used_len
     end
 
-    def write (x, y, message, font)
-
-
+    # @param [Integer] x
+    # @param [Integer] y
+    # @param [Array] message
+    # @param [Bash_Visual::Font] font
+    def write(x, y, message, font)
       string = ''
       message.each_with_index { |text, i|
        string << @console.write_to_position(x, y + i, text, font)

data/lib/bash-visual/version.rb

@@ -1,3 +1,3 @@
 module Bash_Visual
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/lib/bash-visual/vertical_scroll.rb

@@ -32,7 +32,7 @@ module Bash_Visual
       end
 
       if @separator == true
-        message[message.size-1] = Font.new(Font::UNDERLINE, font.foreground, font.background).to_bash +
+        message[message.size-1] = Font.new(:underline, font.foreground, font.background).to_bash +
           message.last.ljust(available_area_width, ' ')
       end
 

data/test/builder_test.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+$:.unshift(File.dirname(__FILE__))
+
+require 'helper'
+
+class BuilderTest < Test::Unit::TestCase
+
+  def test_clear
+    font_mock = Bash_Visual::Font.new
+    font_mock.to_bash {'X'}
+
+    builder = Bash_Visual::Builder.new(font_mock)
+
+    result = builder.clear
+    assert_equal("\e[0;0H\e[2J", result)
+  end
+
+end

data/test/font_test.rb

@@ -0,0 +1,84 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'helper'
+
+class FontTest < Test::Unit::TestCase
+
+  include Bash_Visual
+
+  def test_inspect
+
+    font = Font.new
+
+    expected = '<Font types=%s, foreground=%s, background=nil>' %
+        [font.types, font.foreground]
+
+    assert_equal(expected, font.inspect)
+  end
+
+  def test_font_all
+    font = Font.new([:underline, :bold, :blink])
+    expected = ["\e[1;4;5;97m", "\e[1;5;4;97m","\e[4;1;5;97m", "\e[4;5;1;97m", "\e[5;1;4;97m", "\e[5;4;1;97m"]
+
+    assert_include expected, font.to_s
+  end
+
+  def test_font_without_blink
+    font = Font.new [:underline, :bold]
+
+    expected = ["\e[4;1;97m", "\e[1;4;97m"]
+    assert_include expected, font.to_s
+  end
+
+  def test_font_underline
+    font = Font.new(:underline)
+
+    assert_equal "\e[4;97m", font.to_s
+  end
+
+  def test_font_bold
+    font = Font.new([:bold])
+
+    assert_equal "\e[1;97m", font.to_s
+  end
+
+  def test_font_foreground
+    font = Font.new(:std, :dark_cyan)
+    assert_equal "\e[0;36m", font.to_s
+
+    font = Font.new(:std, :green)
+    assert_equal "\e[0;92m", font.to_s
+  end
+
+
+  def test_font_background
+    font = Font.new(:std, :white, :dark_cyan)
+    assert_equal "\e[0;97;46m", font.to_s
+
+    font = Font.new(:std, :white, :green)
+    assert_equal "\e[0;97;102m", font.to_s
+  end
+
+
+  def test_rand_color
+    mock_class_method(Font, "def rand (max=0); 3; end")
+    color = Font::rand_color
+    assert_equal :dark_yellow, color
+
+    mock_class_method(Font, "def rand (max=0); 15; end")
+    color = Font::rand_color :white
+    assert_not_equal(color, :white)
+
+  end
+
+  protected
+
+  def mock_class_method(class_name, eval_string)
+    eigenclass = class << class_name
+      self
+    end
+    eigenclass.class_eval eval_string
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require "simplecov"
+require "test/unit"
+require "bash-visual"
+
+SimpleCov.coverage_dir('../.coverage')
+SimpleCov.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bash-visual
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-26 00:00:00.000000000 Z
+date: 2012-07-18 00:00:00.000000000 Z
 dependencies: []
 description: Bash visualisation tools
 email:
@@ -20,11 +20,13 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bash-visual.gemspec
+- example/hello_world.rb
+- example/random.rb
+- example/spectrum.rb
 - lib/bash-visual.rb
 - lib/bash-visual/builder.rb
 - lib/bash-visual/console.rb
@@ -33,7 +35,10 @@ files:
 - lib/bash-visual/scroll.rb
 - lib/bash-visual/version.rb
 - lib/bash-visual/vertical_scroll.rb
-homepage: https://github.com/AlmazKo/BashConsole
+- test/builder_test.rb
+- test/font_test.rb
+- test/helper.rb
+homepage: https://github.com/AlmazKo/BashVisual
 licenses:
 - MIT
 post_install_message: 

data/Gemfile.lock

@@ -1,14 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bash-visual (1.0.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bash-visual!