formatador 0.2.3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58153bcd41291dcdd4aa4bbcfb724d233604d130470634682306fb0e8859f041
+  data.tar.gz: 20d3a52adff269f0a29fc6c1dda6dd87679151fa13bc496f0fbb1a7edc3ae07b
+SHA512:
+  metadata.gz: 12616b0af1aea1c3b5ee100440096e7b8def45f9ed5340efd98bbc958384005b80cb9dde10d16e0f443f8520b7466a67d93fe5d03a980a19988c3db9e08eef0f
+  data.tar.gz: 7fd4a23d9cd157ed4e86dcec4ad15cbd277220c1c62346f36d414af5aac1db8a634a57e952073cca1feb015c039cd777b18dbbb9fadf24c983025ee4bdbf7e01

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+## Getting Involved
+
+New contributors are always welcome, when it doubt please ask questions. We strive to be an open and welcoming community. Please be nice to one another.
+
+### Coding
+
+* Pick a task:
+  * Offer feedback on open [pull requests](https://github.com/geemus/formatador/pulls).
+  * Review open [issues](https://github.com/geemus/formatador/issues) for things to help on.
+  * [Create an issue](https://github.com/geemus/formatador/issues/new) to start a discussion on additions or features.
+* Fork the project, add your changes and tests to cover them in a topic branch.
+* Commit your changes and rebase against `geemus/formatador` to ensure everything is up to date.
+* [Submit a pull request](https://github.com/geemus/formatador/compare/).
+
+### Non-Coding
+
+* Offer feedback on open [issues](https://github.com/geemus/formatador/issues).
+* Organize or volunteer at events.

data/CONTRIBUTORS.md

@@ -0,0 +1,16 @@
+* Bohuslav Kabrda <bkabrda@redhat.com>
+* Chris Howe <chris@howeville.com>
+* Damien Pollet <damien.pollet@gmail.com>
+* Daniel Lv <lgn21st@gmail.com>
+* Gabe Martin-Dempesy <gabe@mudbugmedia.com>
+* Kevin Menard <nirvdrum@gmail.com>
+* Mal Curtis <mal@sitepoint.com>
+* Matt Bridges <mbridges.91@gmail.com>
+* Matt Petty <matt@kizmeta.com>
+* Nathaniel Eliot <temujin9@t9productions.com>
+* Wesley Beary <geemus@engineyard.com>
+* Wesley Beary <geemus@gmail.com>
+* Wesley Beary <wbeary@engineyard.com>
+* Wesley Beary <wesley@heroku.com>
+* geemus (Wesley Beary) <wbeary@engineyard.com>
+* geemus <geemus@gmail.com>

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2009-2013 [CONTRIBUTORS.md](https://github.com/geemus/formatador/blob/master/CONTRIBUTORS.md)
+
+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.rdoc → README.md}

@@ -1,75 +1,129 @@
-= formatador
+# formatador
 
 STDOUT text formatting
 
-== Quick and dirty
+[![Build Status](https://github.com/geemus/formatador/actions/workflows/ruby.yml/badge.svg)](https://github.com/geemus/formatador/actions/workflows/ruby.yml)
+
+## 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.
 
-=== 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) 2022 [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}"
@@ -88,7 +84,7 @@ task :release => :build do
     puts "You must be on the master branch to release!"
     exit!
   end
-  sh "sudo gem install pkg/#{name}-#{version}.gem"
+  sh "gem install pkg/#{name}-#{version}.gem"
   sh "git commit --allow-empty -a -m 'Release #{version}'"
   sh "git tag v#{version}"
   sh "git push origin master"
@@ -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,47 @@
+v1.0.0 01/20/21
+===============
+
+release v1, it's been stable for ages
+
+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
+===============
+
+* fix typo in readme
+* ensure indent is reset
+* add progress bar object
+* improve thread safety for progress bar
+
+v0.2.4 10/26/12
+===============
+
+* sort background colors higher
+* fix homepage link in gem metadata
+
 v0.2.3 05/18/12
 ===============
 

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.3'
-  s.date              = '2012-05-18'
-  s.rubyforge_project = 'formatador'
+  s.version           = '1.0.0'
+  s.date              = '2022-01-20'
 
   ## 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/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
@@ -60,8 +61,11 @@ Gem::Specification.new do |s|
   ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
+    CONTRIBUTING.md
+    CONTRIBUTORS.md
     Gemfile
-    README.rdoc
+    LICENSE.md
+    README.md
     Rakefile
     changelog.txt
     formatador.gemspec

data/lib/formatador/progressbar.rb

@@ -1,5 +1,36 @@
+require 'thread'
+
 class Formatador
 
+  class ProgressBar
+
+    attr_accessor :current, :total, :opts
+
+    def initialize(total, opts = {}, &block)
+      @current = opts.delete(:start) || 0
+      @total   = total.to_i
+      @opts    = opts
+      @lock    = Mutex.new
+      @complete_proc = block_given? ? block : Proc.new { }
+    end
+
+    def increment(increment = 1)
+      @lock.synchronize do
+        return if complete?
+        @current += increment.to_i
+        @complete_proc.call(self) if complete?
+        Formatador.redisplay_progressbar(current, total, opts)
+      end
+    end
+
+    private
+
+      def complete?
+        current == total
+      end
+
+  end
+
   def redisplay_progressbar(current, total, options = {})
     options = { :color => 'white', :width => 50, :new_line => true }.merge!(options)
     data = progressbar(current, total, options)

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/lib/formatador.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'formatador', 'progressbar')
 
 class Formatador
 
-  VERSION = '0.2.3'
+  VERSION = '1.0.0'
 
   STYLES = {
     :"\/"             => "0",
@@ -17,15 +17,6 @@ class Formatador
     :underline_none   => "24",
     :blink_off        => "25",
     :positive         => "27", # revert color/color
-    :black            => "30",
-    :red              => "31",
-    :green            => "32",
-    :yellow           => "33",
-    :blue             => "34",
-    :magenta          => "35",
-    :purple           => "35",
-    :cyan             => "36",
-    :white            => "37",
     :_black_          => "40",
     :_red_            => "41",
     :_green_          => "42",
@@ -35,14 +26,6 @@ class Formatador
     :_purple_         => "45",
     :_cyan_           => "46",
     :_white_          => "47",
-    :light_black      => "90",
-    :light_red        => "91",
-    :light_green      => "92",
-    :light_yellow     => "93",
-    :light_blue       => "94",
-    :light_magenta    => "95",
-    :light_purple     => "95",
-    :light_cyan       => "96",
     :_light_black_    => "100",
     :_light_red_      => "101",
     :_light_green_    => "102",
@@ -51,6 +34,23 @@ class Formatador
     :_light_magenta_  => "105",
     :_light_purple_   => "105",
     :_light_cyan_     => "106",
+    :black            => "30",
+    :red              => "31",
+    :green            => "32",
+    :yellow           => "33",
+    :blue             => "34",
+    :magenta          => "35",
+    :purple           => "35",
+    :cyan             => "36",
+    :white            => "37",
+    :light_black      => "90",
+    :light_red        => "91",
+    :light_green      => "92",
+    :light_yellow     => "93",
+    :light_blue       => "94",
+    :light_magenta    => "95",
+    :light_purple     => "95",
+    :light_cyan       => "96",
   }
 
   PARSE_REGEX  = /\[(#{ STYLES.keys.join('|') })\]/ix
@@ -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)
@@ -90,6 +90,7 @@ class Formatador
   def indent(&block)
     @indent += 1
     yield
+  ensure
     @indent -= 1
   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 => '震度'}])").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,47 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: formatador
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - geemus (Wesley Beary)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70358162087440 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70358162087440
+  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: &70358162112100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70358162112100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: STDOUT text formatting
 email: geemus@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
+- CONTRIBUTING.md
+- CONTRIBUTORS.md
 - Gemfile
-- README.rdoc
+- LICENSE.md
+- README.md
 - Rakefile
 - changelog.txt
 - formatador.gemspec
@@ -51,29 +73,28 @@ files:
 - tests/basic_tests.rb
 - tests/table_tests.rb
 - tests/tests_helper.rb
-homepage: http://github.com/geemus/NAME
-licenses: []
-post_install_message: 
+homepage: https://github.com/geemus/formatador
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 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: formatador
-rubygems_version: 1.8.15
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 2
 summary: Ruby STDOUT text formatting
 test_files: []