bar-of-progress 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.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 86e98d04262c8491ed88097371ecdd752c51c366
4
+ data.tar.gz: e19e795fc5a466a1cea901892b7d514d7e9556cf
5
+ SHA512:
6
+ metadata.gz: e68d1c2e0ddec2e343f2864cd4f6840d03ad5790b57c19df690913e5dbaec4e8fb817655e8dc474d29557dd1dbe19a15221993ed3a54e7493736c969c5f5387c
7
+ data.tar.gz: 025d5d3f511d4d0099dfb4517262a840c083f949b70e740224b8d4d589b20e70be9d04198495f2db288a3a1ca1734a512ff8ffc2210e14757570d87e4d7fc08b
data/.gitignore ADDED
@@ -0,0 +1,22 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ *.bundle
19
+ *.so
20
+ *.o
21
+ *.a
22
+ mkmf.log
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --require "spec_helper"
data/Gemfile ADDED
@@ -0,0 +1,11 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in bar_of_progress.gemspec
4
+ gemspec
5
+
6
+
7
+ group :development, :test do
8
+ gem 'rspec'
9
+ gem 'rspec-given'
10
+ gem 'pry'
11
+ end
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Justin Searls
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,19 @@
1
+ # bar-of-progress
2
+
3
+ Everyone knows that progress bars are one of the hard, unsolved problems of computer science, so I decided to give it a shot.
4
+
5
+ ![xkcd rocks](http://imgs.xkcd.com/comics/estimation.png)
6
+
7
+ ## API
8
+
9
+ Boring, normal progress bars:
10
+
11
+ ``` ruby
12
+ bar = BarOfProgress.new #=> defaults to completeness == "100"
13
+
14
+ bar.progress #=> "[◌◌◌◌◌◌◌◌◌◌]"
15
+
16
+ bar.progress(50) #=> "[●●●●●◌◌◌◌◌]"
17
+
18
+ bar.progress(49) #=> "[●●●●◍◌◌◌◌◌]"
19
+ ```
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
@@ -0,0 +1,23 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'bar_of_progress/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "bar-of-progress"
8
+ spec.version = BarOfProgress::VERSION
9
+ spec.authors = ["Justin Searls"]
10
+ spec.email = ["searls@gmail.com"]
11
+ spec.summary = %q{Render custom textual progress bars}
12
+ spec.description = %q{Render custom textual progress bars with a simple little API}
13
+ spec.homepage = "https://github.com/searls/bar-of-progress"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.6"
22
+ spec.add_development_dependency "rake"
23
+ end
@@ -0,0 +1,26 @@
1
+ require "bar_of_progress/version"
2
+
3
+ class BarOfProgress
4
+ def initialize
5
+ @complete = 100.0
6
+ end
7
+
8
+ def progress(amount = 0)
9
+ bubbles = betwixt(((amount / @complete) * 10), 0, 10)
10
+ full_bubbles = bubbles.floor
11
+ partial_bubbles = bubbles % 1 == 0 ? 0 : 1
12
+ "[#{chars('●', full_bubbles)}#{chars('◍', partial_bubbles)}#{chars('◌', (10 - full_bubbles - partial_bubbles))}]"
13
+ end
14
+
15
+ private
16
+
17
+ # This method is amazing.
18
+ def betwixt(n, min, max)
19
+ [[n, min].max, max].min
20
+ end
21
+
22
+ def chars(char, n)
23
+ return "" if n <= 0
24
+ char * n
25
+ end
26
+ end
@@ -0,0 +1,3 @@
1
+ class BarOfProgress
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,15 @@
1
+ require 'bar-of-progress'
2
+
3
+ describe BarOfProgress do
4
+ context "vanilla default progress bar" do
5
+ subject { BarOfProgress.new }
6
+
7
+ Then { subject.progress(-1) == "[◌◌◌◌◌◌◌◌◌◌]" }
8
+ Then { subject.progress == "[◌◌◌◌◌◌◌◌◌◌]" }
9
+ Then { subject.progress(0) == "[◌◌◌◌◌◌◌◌◌◌]" }
10
+ Then { subject.progress(49) == "[●●●●◍◌◌◌◌◌]" }
11
+ Then { subject.progress(50) == "[●●●●●◌◌◌◌◌]" }
12
+ Then { subject.progress(100) == "[●●●●●●●●●●]" }
13
+ Then { subject.progress(101) == "[●●●●●●●●●●]" }
14
+ end
15
+ end
@@ -0,0 +1,3 @@
1
+ require 'rspec/given'
2
+
3
+ require 'pry'
metadata ADDED
@@ -0,0 +1,85 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: bar-of-progress
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Justin Searls
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-08-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.6'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ description: Render custom textual progress bars with a simple little API
42
+ email:
43
+ - searls@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - .gitignore
49
+ - .rspec
50
+ - Gemfile
51
+ - LICENSE.txt
52
+ - README.md
53
+ - Rakefile
54
+ - bar_of_progress.gemspec
55
+ - lib/bar-of-progress.rb
56
+ - lib/bar_of_progress/version.rb
57
+ - spec/lib/bar_of_progress_spec.rb
58
+ - spec/spec_helper.rb
59
+ homepage: https://github.com/searls/bar-of-progress
60
+ licenses:
61
+ - MIT
62
+ metadata: {}
63
+ post_install_message:
64
+ rdoc_options: []
65
+ require_paths:
66
+ - lib
67
+ required_ruby_version: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - '>='
70
+ - !ruby/object:Gem::Version
71
+ version: '0'
72
+ required_rubygems_version: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - '>='
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ requirements: []
78
+ rubyforge_project:
79
+ rubygems_version: 2.3.0
80
+ signing_key:
81
+ specification_version: 4
82
+ summary: Render custom textual progress bars
83
+ test_files:
84
+ - spec/lib/bar_of_progress_spec.rb
85
+ - spec/spec_helper.rb