formatador 0.2.5 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZmFhYzcyNjZlYTkzM2RmZTBhYmY1OWJmN2ViOWUyMzYyNmIyYzdiMw==
-  data.tar.gz: !binary |-
-    MGRkYmM5ZGM0OTliYjI4NjEwY2M3NDZmYWI2NWYwOTZjM2ZkOWExMw==
+SHA256:
+  metadata.gz: 371ea2974db0d03751e1a559433313ef4f7e7c2c46cabba41f004dba91632065
+  data.tar.gz: 05ee97c7103cb73f5a6ee26e135a828f2c8d738937409a933c379f66b0f2cd76
 SHA512:
-  metadata.gz: !binary |-
-    Y2VhYjM0NzZkYmExYmQ5OTMwZjI5ZmZhYTllNTBmNzdlMDEzNDk4NWVmZTVj
-    MmU0ZjEwZTVhOTdlZWU3ZGYyOTE5YTc3YTA4Y2MxNDM3MDQyYmY0ZjMzNmY3
-    YTIxNDY1MDMwM2ZiOGI1MzQ3ODJiYWRlZmNiMzIyOWFmNzBiZDY=
-  data.tar.gz: !binary |-
-    YzcyNzFhYTk2ODI2YjUzZTlhZTAxNWI0MTYzZmJlNGY2MjU2Y2M5MTAxY2Fl
-    OTViZGRlMWVlODgwMWNmOWExNTZlYWY5YzFhNjc4Yzg3Y2IxZDQ5YjJjN2Iw
-    OWUyYjI5ZjAyNDg3Mzk0YmVlMDA5MmU0ZDU3ZmMxOTUyYzRjNjI=
+  metadata.gz: dbec7dda7093e08b69ff2372fbbff210cc7d6bde6f2d03e6ca5bf4ed03ff0e75ed7791c4a53812f7f1804c11ed801fbad3acadc71dd48a769977f42cde522ddc
+  data.tar.gz: 54c7902a6d39b65d929c02f9f66c490f27753c3aec04d27c3921b33f8d3a49bc9524965d52eaac0fdd14a7892f0797d38f0e5c758d6c55dd026d465517160e4b

data/{README.rdoc → README.md}

@@ -1,101 +1,129 @@
-= formatador
+# formatador
 
 STDOUT text formatting
 
-== Quick and dirty
+[![Build Status](https://travis-ci.org/geemus/formatador.svg)](http://travis-ci.org/geemus/formatador)
+
+## Quick and dirty
 
 You can call class methods to print out single lines like this:
 
-  Formatador.display_line('Hello World')
+```ruby
+Formatador.display_line('Hello World')
+```
 
 You use tags, similar to html, to set formatting options:
 
-  Formatador.display_line('[green]Hello World[/]')
+```ruby
+Formatador.display_line('[green]Hello World[/]')
+```
 
-  [/] resets everything to normal, colors are supported and [_color_] sets the background color.
+`[/]` resets everything to normal, colors are supported and `[_color_]` sets the background color.
 
-== Standard options
+## Standard options
 
 * format - and adds color codes if STDOUT.tty? is true
 * display - calls format on the input and prints it
 * display_line - calls display, but adds on a newline (\n)
 * redisplay - Displays text, prepended with \r which will overwrite the last existing line
 
-== Extensions
+## Extensions
 
 * display_table: takes an array of hashes. Each hash is a row, with the keys being the headers and values being the data. An optional second argument can specify which headers/columns to include and in what order they should appear.
 * display_compact_table: Same as display_table, execpt that split lines are not drawn by default in the body of the table. If you need a split line, put a :split constant in the body array.
 * redisplay_progressbar: takes the current and total values as its first two arguments and redisplays a progressbar (until current = total and then it display_lines). An optional third argument represents the start time and will add an elapsed time counter.
 
-=== Progress Bar examples
-
-  total    = 1000
-  progress = ProgressBar.new(total)
-  1000.times do
-    progress.increment
-  end
-
-   978/1000  |************************************************* |
-
-  # Change the color of the bar
-
-  total    = 1000
-  progress = ProgressBar.new(total, :color => "light_blue")
-  1000.times do
-    progress.increment
-  end
-
-  # Change the color of a completed progress bar
-
-  total    = 1000
-  progress = ProgressBar.new(total) { |b| b.opts[:color] = "green" }
-  1000.times do
-    progress.increment
-  end
-
-=== Table examples
-
-  table_data = [{:name => "Joe", :food => "Burger"}, {:name => "Bill", :food => "French fries"}]
-  Formatador.display_table(table_data)
-
-  +------+--------------+
-  | name | food         |
-  +------+--------------+
-  | Joe  | Burger       |
-  +------+--------------+
-  | Bill | French fries |
-  +------+--------------+
-
-  table_data = [
-    {:name => "Joe", :meal => {:main_dish => "Burger", :drink => "water"}}, 
-    {:name => "Bill", :meal => {:main_dish => "Chicken", :drink => "soda"}}
-  ]
-  Formatador.display_table(table_data, [:name, :"meal.drink"])
+### Progress Bar examples
+
+```ruby
+total    = 1000
+progress = Formatador::ProgressBar.new(total)
+
+1000.times do
+  progress.increment
+end
+
+#=> 978/1000  |************************************************* |
+
+# Change the color of the bar
+total    = 1000
+progress = Formatador::ProgressBar.new(total, :color => "light_blue")
+
+1000.times do
+  progress.increment
+end
+
+# Change the color of a completed progress bar
+total    = 1000
+progress = Formatador::ProgressBar.new(total) { |b| b.opts[:color] = "green" }
+
+1000.times do
+  progress.increment
+end
+```
+
+### Table examples
+
+```ruby
+table_data = [
+  { :name => "Joe",  :food => "Burger" },
+  { :name => "Bill", :food => "French fries" }
+]
+Formatador.display_table(table_data)
+
+#=> +------+--------------+
+#   | name | food         |
+#   +------+--------------+
+#   | Joe  | Burger       |
+#   +------+--------------+
+#   | Bill | French fries |
+#   +------+--------------+
+
+table_data = [
+  {
+    :name => "Joe",
+    :meal => {
+      :main_dish => "Burger",
+      :drink => "water"
+    }
+  },
+  {
+    :name => "Bill",
+    :meal => {
+      :main_dish => "Chicken",
+      :drink => "soda"
+    }
+  }
+]
+Formatador.display_table(table_data, [:name, :"meal.drink"])
 
-  +------+------------+
-  | name | meal.drink |
-  +------+------------+
-  | Joe  | water      |
-  +------+------------+
-  | Bill | soda       |
-  +------+------------+
+#=> +------+------------+
+#   | name | meal.drink |
+#   +------+------------+
+#   | Joe  | water      |
+#   +------+------------+
+#   | Bill | soda       |
+#   +------+------------+
+```
 
-== Indentation
+## Indentation
 
 By initializing a formatador object you can keep track of indentation:
 
-  formatador = Formatador.new
-  formatador.display_line('one level of indentation')
-  formatador.indent {
-    formatador.display_line('two levels of indentation')
-  }
-  formatador.display_line('one level of indentation')
+```ruby
+formatador = Formatador.new
+formatador.display_line('one level of indentation')
+formatador.indent {
+  formatador.display_line('two levels of indentation')
+}
+formatador.display_line('one level of indentation')
+```
 
-== Copyright
+## Copyright
 
 (The MIT License)
 
-Copyright (c) 2009 {geemus (Wesley Beary)}[http://github.com/geemus]
+Copyright (c) 2015 [geemus (Wesley Beary)](http://github.com/geemus)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -21,10 +21,6 @@ def date
   Date.today.to_s
 end
 
-def rubyforge_project
-  name
-end
-
 def gemspec_file
   "#{name}.gemspec"
 end
@@ -56,7 +52,7 @@ task :coverage do
   sh "open coverage/index.html"
 end
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "#{name} #{version}"
@@ -111,8 +107,6 @@ task :gemspec => :validate do
   replace_header(head, :name)
   replace_header(head, :version)
   replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
 
   # determine file list from git ls-files
   files = `git ls-files`.

data/changelog.txt

@@ -1,3 +1,28 @@
+v0.3.0 06/17/21
+===============
+
+add travis badge to readme
+change readme to md
+fix markdown readme
+fix travis badge
+monkey-patch StringIO to try and fix jruby build
+override tty? for jruby build
+fix copyright statement
+use unicode.width instead of string.length
+remove unicode from requirements, use only if loaded
+display datum who's value is a FalseClass
+more colors with syntax-specific code/length limitations
+better code visualization in readme
+update readme
+remove broken rubinius build from CI
+fix length method to detect multibyte char width
+fix test for table with multi byte chars
+support multibyte characters
+update CI to 2.2.7, 2.3.4, and 2.4.1
+drop rubyforge_project from gemspec and rakefile
+change github reference to https
+change readme.rdoc to readme.md in gemspec
+
 v0.2.5 05/23/14
 ===============
 

data/formatador.gemspec

@@ -13,9 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'formatador'
-  s.version           = '0.2.5'
-  s.date              = '2014-05-23'
-  s.rubyforge_project = 'formatador'
+  s.version           = '0.3.0'
+  s.date              = '2021-06-17'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -27,7 +26,8 @@ Gem::Specification.new do |s|
   ## a custom homepage, consider using your GitHub URL or the like.
   s.authors  = ["geemus (Wesley Beary)"]
   s.email    = 'geemus@gmail.com'
-  s.homepage = "http://github.com/geemus/#{s.name}"
+  s.homepage = "https://github.com/geemus/#{s.name}"
+  s.license  = 'MIT'
 
   ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
   ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
   ## Specify any RDoc options here. You'll want to add your README and
   ## LICENSE files to the extra_rdoc_files list.
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README.rdoc]
+  s.extra_rdoc_files = %w[README.md]
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
@@ -53,6 +53,7 @@ Gem::Specification.new do |s|
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
   s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
   s.add_development_dependency('shindo')
 
   ## Leave this section as-is. It will be automatically generated from the
@@ -64,7 +65,7 @@ Gem::Specification.new do |s|
     CONTRIBUTORS.md
     Gemfile
     LICENSE.md
-    README.rdoc
+    README.md
     Rakefile
     changelog.txt
     formatador.gemspec

data/lib/formatador.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'formatador', 'progressbar')
 
 class Formatador
 
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 
   STYLES = {
     :"\/"             => "0",
@@ -62,7 +62,7 @@ class Formatador
 
   def display(string = '')
     print(parse("[indent]#{string}"))
-    STDOUT.flush
+    $stdout.flush
     nil
   end
 
@@ -80,7 +80,7 @@ class Formatador
   end
 
   def parse(string)
-    if STDOUT.tty?
+    if $stdout.tty?
       string.gsub(PARSE_REGEX) { "\e[#{STYLES[$1.to_sym]}m" }.gsub(INDENT_REGEX) { indentation }
     else
       strip(string)

data/lib/formatador/table.rb

@@ -80,7 +80,14 @@ class Formatador
   private
 
   def length(value)
-    value.to_s.gsub(PARSE_REGEX, '').length
+    if Module.const_defined?(:Unicode)
+      Unicode.width(value.to_s.gsub(PARSE_REGEX, ''))
+    else
+      value.to_s.gsub(PARSE_REGEX, '').chars.reduce(0) { |sum, char| sum += char.bytesize > 1 ? 2 : 1 }
+    end
+
+  rescue NotImplementedError
+    value.to_s.gsub(PARSE_REGEX, '').chars.reduce(0) { |sum, char| sum += char.bytesize > 1 ? 2 : 1 }
   end
 
   def calculate_datum(header, hash)
@@ -91,7 +98,7 @@ class Formatador
         datum = d[split] || d[split.to_sym] || ''
       end
     else
-      datum = hash[header] || ''
+      datum = hash.fetch(header, '')
     end
     datum
   end

data/tests/table_tests.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 Shindo.tests("Formatador: tables") do
 
 output = <<-OUTPUT
@@ -93,4 +94,22 @@ output = Formatador.parse(output)
     end
   end
 
-end
+
+output = <<-OUTPUT
+    +------+
+    | [bold]a[/]    |
+    +------+
+    | 1    |
+    +------+
+    | 震度 |
+    +------+
+OUTPUT
+  output = Formatador.parse(output)
+
+  tests("#display_table([{:a => 1}, {:a => 2}])").returns(output) do
+    capture_stdout do
+      Formatador.display_table([{:a => 1}, {:a => "震度"}])
+    end
+  end
+
+end

data/tests/tests_helper.rb

@@ -5,6 +5,18 @@ require 'rubygems'
 require 'shindo'
 require 'stringio'
 
+class IO
+  def tty?
+    true
+  end
+end
+
+class StringIO
+  def tty?
+    true
+  end
+end
+
 def capture_stdout
   old_stdout = $stdout
   new_stdout = StringIO.new

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: formatador
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - geemus (Wesley Beary)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shindo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: STDOUT text formatting
@@ -43,13 +57,13 @@ email: geemus@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
 - Gemfile
 - LICENSE.md
-- README.rdoc
+- README.md
 - Rakefile
 - changelog.txt
 - formatador.gemspec
@@ -59,29 +73,28 @@ files:
 - tests/basic_tests.rb
 - tests/table_tests.rb
 - tests/tests_helper.rb
-homepage: http://github.com/geemus/formatador
-licenses: []
+homepage: https://github.com/geemus/formatador
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 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: formatador
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 2
 summary: Ruby STDOUT text formatting
 test_files: []
-has_rdoc: