rake-progressbar 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/Gemfile ADDED
@@ -0,0 +1,13 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+
6
+ # Add dependencies to develop your gem here.
7
+ # Include everything needed to run rake, tests, features, etc.
8
+ group :development do
9
+ gem "shoulda", ">= 0"
10
+ gem "bundler", "~> 1.0.0"
11
+ gem "jeweler", "~> 1.6.4"
12
+ # gem "rcov", ">= 0"
13
+ end
@@ -0,0 +1,18 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ git (1.2.5)
5
+ jeweler (1.6.4)
6
+ bundler (~> 1.0)
7
+ git (>= 1.2.5)
8
+ rake
9
+ rake (0.9.2)
10
+ shoulda (2.11.3)
11
+
12
+ PLATFORMS
13
+ ruby
14
+
15
+ DEPENDENCIES
16
+ bundler (~> 1.0.0)
17
+ jeweler (~> 1.6.4)
18
+ shoulda
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2011 Ondřej Bartas
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,21 @@
1
+ = rake-progressbar
2
+
3
+ Progress bar for long runnung jobs in terminal - useful mostly for rake tasks (imports, exports, archives etc.)
4
+
5
+ == Usage
6
+ RakeProgressbar.new(maximal_count) - in maximal count you are passing number 1> ho many jobs (increments you will perform)
7
+
8
+ bar = RakeProgressbar.new(100)
9
+ 100.times do
10
+ bar.inc
11
+ end
12
+ bar.finished
13
+
14
+ It will generate:
15
+ 25.2% [#####_______________] 01:02:30 -> 00:25:13
16
+
17
+ == Copyright
18
+
19
+ Copyright (c) 2011 Ondřej Bartas. See LICENSE.txt for
20
+ further details.
21
+
@@ -0,0 +1,53 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ begin
6
+ Bundler.setup(:default, :development)
7
+ rescue Bundler::BundlerError => e
8
+ $stderr.puts e.message
9
+ $stderr.puts "Run `bundle install` to install missing gems"
10
+ exit e.status_code
11
+ end
12
+ require 'rake'
13
+
14
+ require 'jeweler'
15
+ Jeweler::Tasks.new do |gem|
16
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
+ gem.name = "rake-progressbar"
18
+ gem.homepage = "http://github.com/ondrejbartas/rake-progressbar"
19
+ gem.license = "MIT"
20
+ gem.summary = "Showing progress of long going rake tasks - importing, archivieng etc."
21
+ gem.description = "Easy to use, shows estimated time to finish, elapsed time, percantage, not slowing with very fast jobs (terminal rescreen issue)"
22
+ gem.email = "o.bartas@gmail.com"
23
+ gem.authors = ["Ondřej Bartas"]
24
+ # dependencies defined in Gemfile
25
+ end
26
+ Jeweler::RubygemsDotOrgTasks.new
27
+
28
+ require 'rake/testtask'
29
+ Rake::TestTask.new(:test) do |test|
30
+ test.libs << 'lib' << 'test'
31
+ test.pattern = 'test/**/test_*.rb'
32
+ test.verbose = true
33
+ end
34
+
35
+ #require 'rcov/rcovtask'
36
+ #Rcov::RcovTask.new do |test|
37
+ # test.libs << 'test'
38
+ # test.pattern = 'test/**/test_*.rb'
39
+ # test.verbose = true
40
+ # test.rcov_opts << '--exclude "gems/*"'
41
+ #end
42
+
43
+ task :default => :test
44
+
45
+ require 'rake/rdoctask'
46
+ Rake::RDocTask.new do |rdoc|
47
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
48
+
49
+ rdoc.rdoc_dir = 'rdoc'
50
+ rdoc.title = "rake-progressbar #{version}"
51
+ rdoc.rdoc_files.include('README*')
52
+ rdoc.rdoc_files.include('lib/**/*.rb')
53
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
@@ -0,0 +1,104 @@
1
+ # Progress Bar a la Homebrew for Ruby Scripts
2
+ # ===========================================
3
+
4
+ class RakeProgressbar
5
+ attr_accessor :maximal, :actual, :cols, :finish, :started, :percent, :last_percent, :last_time_dif
6
+
7
+ def initialize(maximal)
8
+ if maximal.nil? || maximal < 1
9
+ return nil
10
+ else
11
+ self.maximal = maximal
12
+ self.started = Time.now
13
+ self.actual = -1
14
+ self.last_percent = -1
15
+ self.cols = detect_terminal_size[0] - 3
16
+ self.cols = 80 if self.cols.nil? || self.cols < 80
17
+ self.finish = false
18
+ STDOUT.sync = true
19
+ if maximal == 0
20
+ puts "nothing to do"
21
+ else
22
+ inc
23
+ end
24
+ return self
25
+ end
26
+ end
27
+
28
+ def inc
29
+ self.actual += 1
30
+ self.percent = (self.actual.to_f/self.maximal.to_f*100.0)
31
+
32
+ display
33
+
34
+ if self.actual == self.maximal && !self.finish
35
+ finished
36
+ end
37
+ end
38
+
39
+ def display
40
+ time_dif = ((Time.now - self.started)).to_i
41
+ if self.percent == 0
42
+ remaining = 0
43
+ else
44
+ remaining = (time_dif.to_f/self.percent.to_f * 100.0).to_i - time_dif
45
+ end
46
+
47
+ if self.last_percent != (self.percent*10).to_i && self.last_time_dif != time_dif
48
+ percent_out = ((self.percent*10).to_i.to_f/10.0).to_s
49
+ if percent < 10
50
+ percent_out = " "+percent_out
51
+ elsif percent < 100
52
+ percent_out = " "+percent_out
53
+ end
54
+ STDOUT.print("\r#{percent_out}% ")
55
+ STDOUT.print( "["+("#" * (self.percent*((self.cols-31).to_f/100)).to_i))
56
+ STDOUT.print( ("_")* ((100-self.percent)*((self.cols-31).to_f/100)).to_i)
57
+ STDOUT.print( "] "+(Time.at(remaining - 60*60).strftime('%H:%M:%S')) )
58
+ STDOUT.print( (" -> ")+(Time.at(time_dif - 60*60).strftime('%H:%M:%S'))+" " )
59
+ self.last_percent = (self.percent*10).to_i
60
+ self.last_time_dif = time_dif
61
+ end
62
+ end
63
+
64
+ def finished(show_actual = false)
65
+ if self.finish == false
66
+ self.last_percent = 990
67
+ self.last_time_dif = -1
68
+ self.percent = 100.0
69
+ if self.maximal != 0
70
+ display
71
+ end
72
+ STDOUT.print "\n"
73
+ if show_actual
74
+ STDOUT.print "Finished #{self.actual} in #{Time.now - self.started}s\n"
75
+ else
76
+ STDOUT.print "Finished in #{Time.now - self.started}s\n"
77
+ end
78
+ STDOUT.sync = false
79
+ self.finish = true
80
+ end
81
+ end
82
+
83
+
84
+ # Determines if a shell command exists by searching for it in ENV['PATH'].
85
+ def command_exists?(command)
86
+ ENV['PATH'].split(File::PATH_SEPARATOR).any? {|d| File.exists? File.join(d, command) }
87
+ end
88
+
89
+ # Returns [width, height] of terminal when detected, nil if not detected.
90
+ # Think of this as a simpler version of Highline's Highline::SystemExtensions.terminal_size()
91
+ def detect_terminal_size
92
+ if (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/)
93
+ [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
94
+ elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput')
95
+ [`tput cols`.to_i, `tput lines`.to_i]
96
+ elsif STDIN.tty? && command_exists?('stty')
97
+ `stty size`.scan(/\d+/).map { |s| s.to_i }.reverse
98
+ else
99
+ nil
100
+ end
101
+ rescue
102
+ nil
103
+ end
104
+ end
@@ -0,0 +1,56 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{rake-progressbar}
8
+ s.version = "0.0.1"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Ondřej Bartas"]
12
+ s.date = %q{2011-07-28}
13
+ s.description = %q{Easy to use, shows estimated time to finish, elapsed time, percantage, not slowing with very fast jobs (terminal rescreen issue)}
14
+ s.email = %q{o.bartas@gmail.com}
15
+ s.extra_rdoc_files = [
16
+ "LICENSE.txt",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ "Gemfile",
22
+ "Gemfile.lock",
23
+ "LICENSE.txt",
24
+ "README.rdoc",
25
+ "Rakefile",
26
+ "VERSION",
27
+ "lib/rake-progressbar.rb",
28
+ "rake-progressbar.gemspec",
29
+ "test/helper.rb",
30
+ "test/test_rake-progressbar.rb"
31
+ ]
32
+ s.homepage = %q{http://github.com/ondrejbartas/rake-progressbar}
33
+ s.licenses = ["MIT"]
34
+ s.require_paths = ["lib"]
35
+ s.rubygems_version = %q{1.6.2}
36
+ s.summary = %q{Showing progress of long going rake tasks - importing, archivieng etc.}
37
+
38
+ if s.respond_to? :specification_version then
39
+ s.specification_version = 3
40
+
41
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
42
+ s.add_development_dependency(%q<shoulda>, [">= 0"])
43
+ s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
44
+ s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
45
+ else
46
+ s.add_dependency(%q<shoulda>, [">= 0"])
47
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
48
+ s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
49
+ end
50
+ else
51
+ s.add_dependency(%q<shoulda>, [">= 0"])
52
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
53
+ s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
54
+ end
55
+ end
56
+
@@ -0,0 +1,18 @@
1
+ require 'rubygems'
2
+ require 'bundler'
3
+ begin
4
+ Bundler.setup(:default, :development)
5
+ rescue Bundler::BundlerError => e
6
+ $stderr.puts e.message
7
+ $stderr.puts "Run `bundle install` to install missing gems"
8
+ exit e.status_code
9
+ end
10
+ require 'test/unit'
11
+ require 'shoulda'
12
+
13
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
14
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
15
+ require 'rake-progressbar'
16
+
17
+ class Test::Unit::TestCase
18
+ end
@@ -0,0 +1,17 @@
1
+ require 'helper'
2
+
3
+ class TestRakeProgressbar < Test::Unit::TestCase
4
+ should "Rake progress bar return valid object after initialization" do
5
+ bar = RakeProgressbar.new(0)
6
+ assert_not_nil bar
7
+ bar = RakeProgressbar.new(100)
8
+ assert_not_nil bar
9
+ bar = RakeProgressbar.new(500)
10
+ assert_not_nil bar
11
+ bar = RakeProgressbar.new(-100)
12
+ assert_not_nil bar
13
+ bar = RakeProgressbar.new(nil)
14
+ assert_not_nil bar
15
+
16
+ end
17
+ end
metadata ADDED
@@ -0,0 +1,97 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rake-progressbar
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Ondřej Bartas
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2011-07-28 00:00:00.000000000 +02:00
13
+ default_executable:
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: shoulda
17
+ requirement: &2153460120 !ruby/object:Gem::Requirement
18
+ none: false
19
+ requirements:
20
+ - - ! '>='
21
+ - !ruby/object:Gem::Version
22
+ version: '0'
23
+ type: :development
24
+ prerelease: false
25
+ version_requirements: *2153460120
26
+ - !ruby/object:Gem::Dependency
27
+ name: bundler
28
+ requirement: &2153459640 !ruby/object:Gem::Requirement
29
+ none: false
30
+ requirements:
31
+ - - ~>
32
+ - !ruby/object:Gem::Version
33
+ version: 1.0.0
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: *2153459640
37
+ - !ruby/object:Gem::Dependency
38
+ name: jeweler
39
+ requirement: &2153459160 !ruby/object:Gem::Requirement
40
+ none: false
41
+ requirements:
42
+ - - ~>
43
+ - !ruby/object:Gem::Version
44
+ version: 1.6.4
45
+ type: :development
46
+ prerelease: false
47
+ version_requirements: *2153459160
48
+ description: Easy to use, shows estimated time to finish, elapsed time, percantage,
49
+ not slowing with very fast jobs (terminal rescreen issue)
50
+ email: o.bartas@gmail.com
51
+ executables: []
52
+ extensions: []
53
+ extra_rdoc_files:
54
+ - LICENSE.txt
55
+ - README.rdoc
56
+ files:
57
+ - .document
58
+ - Gemfile
59
+ - Gemfile.lock
60
+ - LICENSE.txt
61
+ - README.rdoc
62
+ - Rakefile
63
+ - VERSION
64
+ - lib/rake-progressbar.rb
65
+ - rake-progressbar.gemspec
66
+ - test/helper.rb
67
+ - test/test_rake-progressbar.rb
68
+ has_rdoc: true
69
+ homepage: http://github.com/ondrejbartas/rake-progressbar
70
+ licenses:
71
+ - MIT
72
+ post_install_message:
73
+ rdoc_options: []
74
+ require_paths:
75
+ - lib
76
+ required_ruby_version: !ruby/object:Gem::Requirement
77
+ none: false
78
+ requirements:
79
+ - - ! '>='
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ segments:
83
+ - 0
84
+ hash: 484223446746747687
85
+ required_rubygems_version: !ruby/object:Gem::Requirement
86
+ none: false
87
+ requirements:
88
+ - - ! '>='
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ requirements: []
92
+ rubyforge_project:
93
+ rubygems_version: 1.6.2
94
+ signing_key:
95
+ specification_version: 3
96
+ summary: Showing progress of long going rake tasks - importing, archivieng etc.
97
+ test_files: []