utils_drawer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1156807d839430463b403ef305d252b0579e6ed
+  data.tar.gz: 05dc85d0d046a4800867bd00abd02597397f8d96
+SHA512:
+  metadata.gz: eeccd378c0c5c4f688457bead453a1990eecb26148d1de73a9a6462aa6463b4734240f933ed6d073e700a2a4f507c4aa786448a6cc61f07470e987038bd0eb2d
+  data.tar.gz: 44b53f23f4426a16611475ec8c131835db0bfd0450572994d2032a448d7feb4d9e355419713102a921927ac11c4b36f63f3fe19138cc5fb8dbbb7cf993b5961c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 kaihar4
+
+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,102 @@
+# UtilsDrawer
+
+Helper for drawing utils on CLI.
+
+## Description
+
+UtilsDrawer will help to draw utils such as a table or graph.
+
+Supporting the simple drawing by using Ruby's Block syntax.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utils_drawer'
+```
+
+## Usage
+
+### Table Drawer
+
+Adjeust the column width at first row.
+The column width is 10 by the default.
+It is also possible to specify the column width in UtilsDrawer.column second argument.
+
+```ruby
+require 'utils_drawer'
+
+include UtilsDrawer
+
+table do
+  row do
+    column('NAME')
+    column('SCORE', 20)
+    column('AGE')
+  end
+  row do
+    column('kaihara')
+    column('100,000,000')
+    column('22')
+  end
+  row do
+    column('hogefugahara')
+    column('200,000,000')
+    column('33')
+  end
+end
+```
+
+If the number of characters exceeds the column width, it is omitted.
+
+![table](https://raw.github.com/wiki/kaihar4/utils_drawer/images/table.png)
+
+If you want to change the column width of the default:
+
+```ruby
+...
+
+table(20) do
+...
+end
+```
+
+### Graph Drawer
+
+UtilsDrawer.data accepts the data label in the first argument, the value in the second argument.
+The value is the bar length.
+The color of the bar is determined by the bar length.
+
+```ruby
+require 'utils_drawer'
+
+include UtilsDrawer
+
+graph do
+  data('foo', 10)
+  data('hoge', 17)
+  data('nullpo', 0)
+  data('nullnull', 0)
+  data('nuller', 0)
+  data('nullest', 0)
+  data('bar', 7)
+  data('fuga', 24)
+end
+```
+
+Be omitted value is 0 to continue.
+
+![graph1](https://raw.github.com/wiki/kaihar4/utils_drawer/images/graph1.png)
+
+If you don't want to omit:
+
+```ruby
+...
+
+graph({ omission: false }) do
+...
+end
+```
+
+![graph2](https://raw.github.com/wiki/kaihar4/utils_drawer/images/graph2.png)

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/utils_drawer.rb

@@ -0,0 +1,38 @@
+require 'utils_drawer/table_drawer/table'
+require 'utils_drawer/table_drawer/row'
+require 'utils_drawer/table_drawer/column_validator'
+require 'utils_drawer/table_drawer/column'
+
+require 'utils_drawer/graph_drawer/graph.rb'
+require 'utils_drawer/graph_drawer/data.rb'
+
+module UtilsDrawer
+  def table(min_column_size = 10)
+    @table = TableDrawer::Table.new(min_column_size)
+    yield
+    @table.to_s
+  end
+
+  def row
+    @row = TableDrawer::Row.new
+    yield
+    @table.add(@row)
+  end
+
+  def column(text, size = nil)
+    @column = TableDrawer::Column.new(text, size)
+    @row.add(@column)
+  end
+
+  def graph(option = { omission: true })
+    @graph = GraphDrawer::Graph.new(option)
+    yield
+    @graph.datas_init
+    @graph.to_s
+  end
+
+  def data(item, value)
+    @data = GraphDrawer::Data.new(item, value)
+    @graph.add(@data)
+  end
+end

data/lib/utils_drawer/graph_drawer/data.rb

@@ -0,0 +1,41 @@
+require 'safe_colorize'
+
+module UtilsDrawer
+  module GraphDrawer
+    class Data
+      using SafeColorize
+
+      attr_accessor :item
+      attr_accessor :value
+      attr_accessor :level
+
+      def initialize(item, value)
+        @item = item
+        @value = value
+        @level = nil
+      end
+
+      def to_s
+        color =
+          case @level
+          when 1
+            :green
+          when 2
+            :cyan
+          when 3
+            :blue
+          end
+
+        if @value.zero?
+          draw_str = "#{@item}|"
+        else
+          bar = ' ' * (@value - @value.to_s.size)
+          data_label = @value.to_s.color(:black)
+          draw_str = "#{@item}|#{(bar + data_label).bg_color(color)}"
+        end
+
+        draw_str
+      end
+    end
+  end
+end

data/lib/utils_drawer/graph_drawer/graph.rb

@@ -0,0 +1,101 @@
+module UtilsDrawer
+  module GraphDrawer
+    class Graph
+      def initialize(option)
+        @datas = []
+        @max_item_size = 0
+        @max_value_size = 0
+        @omission = option[:omission]
+      end
+
+      def add(data)
+        @datas << data
+        @max_item_size = data.item.size if @max_item_size < data.item.size
+        @max_value_size = data.value if @max_value_size < data.value
+      end
+
+      def datas_init
+        @datas.each do |data|
+          # Adjust the data item size
+          data.item = adjust_item_size(data)
+
+          # Set the data level
+          data.level = calc_data_level(data)
+        end
+      end
+
+      def to_s
+        puts separate
+
+        ommit_flag = false
+        omitted = false
+
+        @datas.each.with_index do |data, index|
+          ommit_flag = false if ommit_flag == true && !data.value.zero?
+
+          # First and Last
+          if index.zero? || index == @datas.size - 1
+            puts data.to_s
+
+            # Omission
+          elsif ommit_flag == true && omitted == false && @datas[index + 1].value.zero?
+            puts draw_omission
+
+            omitted = true
+
+            # Omitted already
+          elsif ommit_flag == true && omitted == true && @datas[index + 1].value.zero?
+            next
+
+          else
+            puts data.to_s
+
+            omitted = false
+          end
+
+          ommit_flag = true if ommit_flag == false && data.value.zero? && @omission
+        end
+
+        puts separate
+      end
+
+      private
+
+      def adjust_item_size(data)
+        missing_size = @max_item_size - data.item.size
+
+        # Nothing to do
+        return data.item if missing_size.zero?
+
+        if missing_size.even?
+          ' ' * (missing_size / 2) + data.item + ' ' * (missing_size / 2)
+        else
+          ' ' * (missing_size / 2) + data.item + ' ' * (missing_size / 2 + 1)
+        end
+      end
+
+      def calc_data_level(data)
+        basis = (@max_value_size / 3).round
+        if data.value <= basis * 1
+          1
+        elsif data.value <= basis * 2
+          2
+        else
+          3
+        end
+      end
+
+      def separate
+        '=' * (@max_item_size + 1 + (@max_value_size * 2))
+      end
+
+      def draw_omission
+        if @max_item_size.even?
+          ' ' * (@max_item_size / 2) + '|' + ' ' * (@max_item_size / 2 - 1) + '|'
+        else
+          ' ' * (@max_item_size / 2) + '|' + ' ' * (@max_item_size / 2) + '|'
+        end
+      end
+    end
+  end
+end

data/lib/utils_drawer/table_drawer/column.rb

@@ -0,0 +1,20 @@
+require 'safe_colorize'
+
+module UtilsDrawer
+  module TableDrawer
+    class Column
+      using SafeColorize
+      prepend ColumnValidator
+
+      attr_accessor :text
+
+      def initialize(text, size)
+        # Ignore ANSI escape sequences
+        pure_text = text.to_pure
+
+        text += ' ' * (size - pure_text.size) if !size.nil? && size > pure_text.size
+        @text = text
+      end
+    end
+  end
+end

data/lib/utils_drawer/table_drawer/column_validator.rb

@@ -0,0 +1,11 @@
+module UtilsDrawer
+  module TableDrawer
+    module ColumnValidator
+      def initialize(text, size)
+        fail 'Invalid multibyte char' if text =~ /[^\x01-\x7E]/
+
+        super
+      end
+    end
+  end
+end

data/lib/utils_drawer/table_drawer/row.rb

@@ -0,0 +1,15 @@
+module UtilsDrawer
+  module TableDrawer
+    class Row
+      attr_accessor :columns
+
+      def initialize
+        @columns = []
+      end
+
+      def add(column)
+        @columns << column
+      end
+    end
+  end
+end

data/lib/utils_drawer/table_drawer/table.rb

@@ -0,0 +1,85 @@
+require 'safe_colorize'
+
+module UtilsDrawer
+  module TableDrawer
+    class Table
+      using SafeColorize
+
+      def initialize(min_column_size)
+        @rows = []
+        @header_column_sizes = []
+        @min_column_size = min_column_size
+      end
+
+      def add(row)
+        # Means the header
+        if @rows.size.zero?
+          set_header_column_size(row)
+
+        else
+          if row.columns.size != @header_column_sizes.size
+            fail "Bud number of columns (#{row.columns.size} for #{@header_column_sizes.size})"
+          end
+        end
+
+        @rows << row
+      end
+
+      def to_s
+        puts separate
+
+        @rows.each.with_index do |row, index|
+          puts format_line(row)
+          puts separate if index != @rows.size - 1
+        end
+
+        puts separate
+      end
+
+      private
+
+      def set_header_column_size(row)
+        row.columns.each.with_index do |column, index|
+          # Ignore ANSI escape sequences
+          pure_text = column.text.to_pure
+
+          if pure_text.size > @min_column_size
+            @header_column_sizes[index] = pure_text.size
+          else
+            @header_column_sizes[index] = @min_column_size
+          end
+        end
+      end
+
+      def format_line(row)
+        line = '| '
+
+        row.columns.each.with_index do |column, index|
+          # Ignore ANSI escape sequences
+          pure_text = column.text.to_pure
+
+          if pure_text.size < @header_column_sizes[index]
+            line << column.text + ' ' * (@header_column_sizes[index] - pure_text.size)
+
+          elsif pure_text.size > @header_column_sizes[index]
+            line << column.text[0, @header_column_sizes[index] - 3] + '...'
+
+          else
+            line << column.text
+          end
+
+          line << ' | ' if index != row.columns.size - 1
+        end
+
+        line << ' |'
+      end
+
+      def separate
+        left = middle = right = '+'
+        bar = '-'
+
+        left + @header_column_sizes.map { |size| bar * (size + 2) }.join(middle) + right
+      end
+    end
+  end
+end

data/lib/utils_drawer/version.rb

@@ -0,0 +1,3 @@
+module UtilsDrawer
+  VERSION = '0.0.1'
+end

data/utils_drawer.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+require 'utils_drawer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'utils_drawer'
+  spec.version       = UtilsDrawer::VERSION
+  spec.authors       = ['kaihar4']
+  spec.email         = ['kaihar4@gmail.com']
+  spec.summary       = 'Helper for drawing utils on CLI.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/kaihar4/utils_drawer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'safe_colorize'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: utils_drawer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kaihar4
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: safe_colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Helper for drawing utils on CLI.
+email:
+- kaihar4@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/utils_drawer.rb
+- lib/utils_drawer/graph_drawer/data.rb
+- lib/utils_drawer/graph_drawer/graph.rb
+- lib/utils_drawer/table_drawer/column.rb
+- lib/utils_drawer/table_drawer/column_validator.rb
+- lib/utils_drawer/table_drawer/row.rb
+- lib/utils_drawer/table_drawer/table.rb
+- lib/utils_drawer/version.rb
+- utils_drawer.gemspec
+homepage: https://github.com/kaihar4/utils_drawer
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Helper for drawing utils on CLI.
+test_files: []