formatador 0.2.4 → 0.2.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmFhYzcyNjZlYTkzM2RmZTBhYmY1OWJmN2ViOWUyMzYyNmIyYzdiMw==
+  data.tar.gz: !binary |-
+    MGRkYmM5ZGM0OTliYjI4NjEwY2M3NDZmYWI2NWYwOTZjM2ZkOWExMw==
+SHA512:
+  metadata.gz: !binary |-
+    Y2VhYjM0NzZkYmExYmQ5OTMwZjI5ZmZhYTllNTBmNzdlMDEzNDk4NWVmZTVj
+    MmU0ZjEwZTVhOTdlZWU3ZGYyOTE5YTc3YTA4Y2MxNDM3MDQyYmY0ZjMzNmY3
+    YTIxNDY1MDMwM2ZiOGI1MzQ3ODJiYWRlZmNiMzIyOWFmNzBiZDY=
+  data.tar.gz: !binary |-
+    YzcyNzFhYTk2ODI2YjUzZTlhZTAxNWI0MTYzZmJlNGY2MjU2Y2M5MTAxY2Fl
+    OTViZGRlMWVlODgwMWNmOWExNTZlYWY5YzFhNjc4Yzg3Y2IxZDQ5YjJjN2Iw
+    OWUyYjI5ZjAyNDg3Mzk0YmVlMDA5MmU0ZDU3ZmMxOTUyYzRjNjI=

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

@@ -27,6 +27,32 @@ You use tags, similar to html, to set formatting options:
 * 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"}]
@@ -41,8 +67,8 @@ You use tags, similar to html, to set formatting options:
   +------+--------------+
 
   table_data = [
-    {:name => "Joe", :meal => {:main_dish => "Burger", :drink => "water"}, 
-    {:name => "Bill", :meal => {:main_dish => "Chicken", drink => "soda"}
+    {:name => "Joe", :meal => {:main_dish => "Burger", :drink => "water"}}, 
+    {:name => "Bill", :meal => {:main_dish => "Chicken", :drink => "soda"}}
   ]
   Formatador.display_table(table_data, [:name, :"meal.drink"])
 

data/changelog.txt

@@ -1,3 +1,17 @@
+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,8 +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.4'
-  s.date              = '2012-10-26'
+  s.version           = '0.2.5'
+  s.date              = '2014-05-23'
   s.rubyforge_project = 'formatador'
 
   ## Make sure your summary is short. The description may be as long
@@ -60,7 +60,10 @@ 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
+    LICENSE.md
     README.rdoc
     Rakefile
     changelog.txt

data/lib/formatador.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'formatador', 'progressbar')
 
 class Formatador
 
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 
   STYLES = {
     :"\/"             => "0",
@@ -90,6 +90,7 @@ class Formatador
   def indent(&block)
     @indent += 1
     yield
+  ensure
     @indent -= 1
   end
 

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)

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: formatador
 version: !ruby/object:Gem::Version
-  version: 0.2.4
-  prerelease: 
+  version: 0.2.5
 platform: ruby
 authors:
 - geemus (Wesley Beary)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: shindo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -50,7 +45,10 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- CONTRIBUTING.md
+- CONTRIBUTORS.md
 - Gemfile
+- LICENSE.md
 - README.rdoc
 - Rakefile
 - changelog.txt
@@ -63,30 +61,27 @@ files:
 - tests/tests_helper.rb
 homepage: http://github.com/geemus/formatador
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 26397976056427726
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: formatador
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 2
 summary: Ruby STDOUT text formatting
 test_files: []
+has_rdoc: