console_progress_bar 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # ConsoleProgressBar
 
-TODO: Write a gem description
+You can use this gem on rake tasks, migrations or irb scripts for watching to transaction progress
 
 ## Installation
 
@@ -14,11 +14,57 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install console_progressbar
+    $ gem install console_progress_bar
 
 ## Usage
+For counter usage:
 
-TODO: Write usage instructions here
+		pbar = ConsoleProgressBar::ProgressBar.new
+		counter = pbar.counter
+		100.times do
+			sleep(0.1)
+			counter.increase
+		end
+
+		# advanced usage of counter object
+		# total parameter is counts of your total transactions
+		# you can show elapsed time by setting with_elapsed_time parameter to true
+		# you can show calculated time remaining by setting with_remaining_time parameter to true
+		# increament_size parameter sets to increament size
+		counter = pbar.counter(:total => 100, :with_elapsed_time => true, :with_remaining_time => true, :increament_size => 5)
+
+For animation usage:
+
+		pbar = ConsoleProgressBar::ProgressBar.new
+		animator = pbar.animator
+		100.times do
+			sleep(0.1)
+			animator.animate
+		end
+
+		# advanced usage of animator object
+		# total parameter is counts of your total transactions
+		# you can show elapsed time by setting with_elapsed_time parameter to true
+		# you can show calculated time remaining by setting with_remaining_time parameter to true
+		# increament_size parameter sets to increament size
+		animator = pbar.animator(:total => 100, :with_elapsed_time => true, :with_remaining_time => true, :increament_size => 5)
+
+For progressbar usage:
+
+		pbar = ConsoleProgressBar::ProgressBar.new
+		bar = pbar.bar
+		100.times do
+			sleep(0.1)
+			bar.draw
+		end
+
+		# advanced usage of bar object
+		# total parameter is counts of your total transactions
+		# you can show elapsed time by setting with_elapsed_time parameter to true
+		# you can show calculated time remaining by setting with_remaining_time parameter to true
+		# increament_size parameter sets to increament size
+		# width parameter is width of shown progress bar
+		bar = pbar.bar(:total => 100, :with_elapsed_time => true, :with_remaining_time => true, :increament_size => 5, :width => 40)
 
 ## Contributing
 

data/lib/console_progress_bar/print_tools.rb

@@ -17,7 +17,7 @@ module ConsoleProgressBar
 					@output += " "
 				end
 				@output_length = @output.length
-				print @output
+				print @output + "\n"
 			end
 			
 	end

data/lib/console_progress_bar/version.rb

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

data/lib/console_progress_bar.rb

@@ -1,9 +1,9 @@
-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"
+require "console_progress_bar/version"
+require "console_progress_bar/print_tools"
+require "console_progress_bar/extras"
+require "console_progress_bar/counter"
+require "console_progress_bar/animator"
+require "console_progress_bar/bar"
 
 module ConsoleProgressBar
 

metadata

@@ -1,57 +1,55 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: console_progress_bar
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
 platform: ruby
-authors: 
-- "Mehmet Emin \xC4\xB0NA\xC3\x87"
+authors:
+- Mehmet Emin İNAÇ
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-10-25 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        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"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: useful progress bar gem for console usage
-email: 
+email:
 - mehmetemininac@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -65,35 +63,31 @@ files:
 - 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: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+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: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 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
+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: []
-