console_progress_bar 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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,29 @@
+# ConsoleProgressBar
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'console_progress_bar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install console_progressbar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/console_progress_bar.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'console_progress_bar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "console_progress_bar"
+  spec.version       = ConsoleProgressBar::VERSION
+  spec.authors       = ["Mehmet Emin İNAÇ"]
+  spec.email         = ["mehmetemininac@gmail.com"]
+  spec.description   = %q{useful progress bar gem for console usage}
+  spec.summary       = %q{Progress bar implementation for console scripts which you can show elapsed time and remaining time with animation or progressbar or current percent of total transactions}
+  spec.homepage      = "http://github.com/mehmetemininac/progressbar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/console_progress_bar/animator.rb

@@ -0,0 +1,47 @@
+module ConsoleProgressBar
+
+	class Animator
+
+		def initialize(total_count = 100, with_elapsed_time = false, with_remaining_time = false, increment_size = 1)
+			@total = total_count
+			@current = 0
+			@recent = -1
+			@increment_size = increment_size
+			@output = "-|-"
+			@with_elapsed_time = with_elapsed_time
+			@with_remaining_time = with_remaining_time
+			@start = Time.now
+			@prev_time = Time.now
+			@avarage_inceament_time = 0
+			@prev_extra_length = 0
+			@output_length = 0
+		end
+
+		def animate
+			@current += @increment_size
+			if @current >= @total
+				finished
+			else
+				@now = (@current * 1.0 / @total * 100).to_i
+				if @recent != @now
+					@recent = @now
+					shift_back(@output_length + @prev_extra_length)
+					@prev_extra_length = 0
+					case @now % 3
+						when 0 then @output = "-|-"
+						when 1 then @output = "-/-"
+						when 2 then @output = "-\\-"
+					end
+					print @output
+					@output_length = @output.length
+				end
+				prepare_extras
+			end
+		end
+
+		include PrintTools
+		include Extras
+
+	end
+
+end

data/lib/console_progress_bar/bar.rb

@@ -0,0 +1,55 @@
+module ConsoleProgressBar
+
+	class Bar
+
+		def initialize(total_count = 100, with_elapsed_time = false, with_remaining_time = false, increment_size = 1, width = 20)
+			@total = total_count
+			@current = 0
+			@recent = -1
+			@width = width
+			@increment_size = increment_size
+			@output = "|"
+			@width.times do
+				@output += " "
+			end
+			@output += "|"
+			@with_elapsed_time = with_elapsed_time
+			@with_remaining_time = with_remaining_time
+			@start = Time.now
+			@prev_time = Time.now
+			@avarage_inceament_time = 0
+			@prev_extra_length = 0
+			@output_length = 0
+		end
+
+		def draw
+			@current += @increment_size
+			if @current >= @total
+				finished
+			else
+				@now = (@current * 1.0 / @total * @width).to_i
+				if @recent != @now
+					@recent = @now
+					shift_back(@output_length + @prev_extra_length)
+					@prev_extra_length = 0
+					@output = "|"
+					@now.times do
+						@output += "#"
+					end
+					(@width - @now).times do
+						@output += " "
+					end
+					@output += "|"
+					print @output
+					@output_length = @output.length
+				end
+				prepare_extras
+			end
+		end
+
+		include PrintTools
+		include Extras
+
+	end
+
+end

data/lib/console_progress_bar/counter.rb

@@ -0,0 +1,43 @@
+module ConsoleProgressBar
+
+	class Counter
+
+		def initialize(total_count = 100, with_elapsed_time = false, with_remaining_time = false, increment_size = 1)
+			@total = total_count
+			@current = 0
+			@recent = -1
+			@increment_size = increment_size
+			@output = "0%"
+			@with_elapsed_time = with_elapsed_time
+			@with_remaining_time = with_remaining_time
+			@start = Time.now
+			@prev_time = Time.now
+			@avarage_inceament_time = 0
+			@prev_extra_length = 0
+			@output_length = 0
+		end
+
+		def increase
+			@current += @increment_size
+			if @current >= @total
+				finished
+			else
+				@now = (@current * 1.0 / @total * 100).to_i
+				if @recent != @now
+					@recent = @now
+					shift_back(@output_length + @prev_extra_length)
+					@prev_extra_length = 0
+					@output = @now.to_s + "%"
+					print @output
+					@output_length = @output.length
+				end
+				prepare_extras
+			end
+		end
+
+		include PrintTools
+		include Extras
+
+	end
+
+end

data/lib/console_progress_bar/extras.rb

@@ -0,0 +1,33 @@
+module ConsoleProgressBar
+
+	module Extras
+
+		private
+			def prepare_extras
+				extra_infos = ""
+				extra_infos += calculate_elapsed_time if @with_elapsed_time
+				extra_infos += calculate_remaining_time if @with_remaining_time
+				shift_back(@prev_extra_length)
+				print extra_infos
+				@prev_extra_length = extra_infos.length
+			end
+
+			def calculate_elapsed_time
+				elapsed_time = (Time.now - @start).to_i
+				minutes, seconds = elapsed_time.divmod(60)
+				hours, minutes = minutes.divmod(60)
+				" Elapsed Time = %02d:%02d:%02d" % [hours, minutes, seconds]
+			end
+
+			def calculate_remaining_time
+				tmp = Time.now - @prev_time
+				@avarage_inceament_time = (@avarage_inceament_time + tmp) / 2.0
+				minutes, seconds = (@avarage_inceament_time * (@total - @current)).divmod(60)
+				hours, minutes = minutes.divmod(60)
+				@prev_time = Time.now
+				" Time Remaining = %02d:%02d:%02d" % [hours, minutes, seconds]
+			end
+
+	end 
+
+end

data/lib/console_progress_bar/print_tools.rb

@@ -0,0 +1,25 @@
+module ConsoleProgressBar
+
+	module PrintTools
+
+		private
+			def shift_back(length)
+				length.times do	
+					print "\b"
+				end
+			end
+
+			def finished
+				shift_back(@output_length + @prev_extra_length)
+				@end ||= (Time.now - @start).round(2)
+				@output = "100% Finished in #{@end} seconds"
+				((@output_length + @prev_extra_length) - @output.length).times do
+					@output += " "
+				end
+				@output_length = @output.length
+				print @output
+			end
+			
+	end
+
+end

data/lib/console_progress_bar/version.rb

@@ -0,0 +1,3 @@
+module ConsoleProgressBar
+  VERSION = "0.0.1"
+end

data/lib/console_progress_bar.rb

@@ -0,0 +1,40 @@
+require_relative "console_progress_bar/version"
+require_relative "console_progress_bar/print_tools"
+require_relative "console_progress_bar/extras"
+require_relative "console_progress_bar/counter"
+require_relative "console_progress_bar/animator"
+require_relative "console_progress_bar/bar"
+
+module ConsoleProgressBar
+
+  class ProgressBar
+
+  	def counter(options = {})
+  		init_options(options)
+  		ConsoleProgressBar::Counter.new(@total, @with_elapsed_time, @with_remaining_time, @increment_size)
+  	end
+
+  	def animator(options = {})
+  		init_options(options)
+  		ConsoleProgressBar::Animator.new(@total, @with_elapsed_time, @with_remaining_time, @increment_size)
+  	end
+
+  	def bar(options = {})
+  		init_options(options)
+  		ConsoleProgressBar::Bar.new(@total, @with_elapsed_time, @with_remaining_time, @increment_size, @width)
+  	end
+
+  private
+  	def init_options(options = {})
+  		unless options.nil?
+  			@total = options[:total].nil? ? 100 : options[:total]
+  			@with_elapsed_time = options[:with_elapsed_time].nil? ? false : options[:with_elapsed_time]
+  			@with_remaining_time = options[:with_remaining_time].nil? ? false : options[:with_remaining_time]
+  			@increment_size = options[:increment_size].nil? ? 1 : options[:increment_size]
+  			@width = options[:width].nil? ? 20 : options[:width]
+  		end
+  	end
+
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: console_progress_bar
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Mehmet Emin \xC4\xB0NA\xC3\x87"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-10-25 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: useful progress bar gem for console usage
+email: 
+- mehmetemininac@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- console_progress_bar.gemspec
+- lib/console_progress_bar.rb
+- lib/console_progress_bar/animator.rb
+- lib/console_progress_bar/bar.rb
+- lib/console_progress_bar/counter.rb
+- lib/console_progress_bar/extras.rb
+- lib/console_progress_bar/print_tools.rb
+- lib/console_progress_bar/version.rb
+has_rdoc: true
+homepage: http://github.com/mehmetemininac/progressbar
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Progress bar implementation for console scripts which you can show elapsed time and remaining time with animation or progressbar or current percent of total transactions
+test_files: []
+