puts_utils 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rubocop.yml +9 -0
- data/.travis.yml +7 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +86 -0
- data/Rakefile +12 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/puts_utils.rb +9 -0
- data/lib/puts_utils/puts_color.rb +25 -0
- data/lib/puts_utils/puts_prompt.rb +24 -0
- data/lib/puts_utils/puts_table.rb +14 -0
- data/lib/puts_utils/puts_table/formatter.rb +40 -0
- data/lib/puts_utils/puts_table/table.rb +24 -0
- data/lib/puts_utils/version.rb +5 -0
- data/puts_utils.gemspec +34 -0
- metadata +119 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: a3600f4b3b3cbf595d8e225e3c237c679c188eea1b3d5b7538720bc7cce9f03e
|
4
|
+
data.tar.gz: 847fea93057b530c4645c9aad96c89951cf85a8b14c0bd26c8e568f3894f25bf
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 71df9abfd71a6710ea726fed8b934cb3118e4ffc7f750f3918da1382270614599351b7dc52835ec88bde7e3f5648017a4b6b4a0cb3a8e8f5cb829284c2665c7e
|
7
|
+
data.tar.gz: ec6b9a46af9929dc60459617a565adcfe34ff05142dd4b324952ad867e6885de4c76c1b951386c2727e5449c2287874ff41e69b3c8562d9c3c3f3989de8124e0
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at lawrance.shepstone@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2019 Lawrance Shepstone
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,86 @@
|
|
1
|
+
# PutsUtils
|
2
|
+
|
3
|
+
Prettier puts formatting for the lazy. Helpful utilities to puts in colour, tables and more.
|
4
|
+
|
5
|
+
|
6
|
+
## Installation
|
7
|
+
|
8
|
+
Add the following line to your application's Gemfile:
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
gem 'puts_utils'
|
12
|
+
```
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
$ bundle
|
17
|
+
|
18
|
+
Or install it yourself as:
|
19
|
+
|
20
|
+
$ gem install puts_utils
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'puts_utils'
|
26
|
+
|
27
|
+
desc 'PutsUtils demo rake task'
|
28
|
+
task puts_utils_demo: do
|
29
|
+
|
30
|
+
#
|
31
|
+
# Include any of the PutsUtils modules you'd like
|
32
|
+
#
|
33
|
+
|
34
|
+
include PutsUtils::PutsColor
|
35
|
+
include PutsUtils::PutsTable
|
36
|
+
include PutsUtils::PutsPrompt
|
37
|
+
|
38
|
+
#
|
39
|
+
# Use puts_color to puts in various colors
|
40
|
+
#
|
41
|
+
|
42
|
+
puts_color 'Danger.', :red
|
43
|
+
puts_color 'Done.', :green
|
44
|
+
puts_color 'Warning.', :yellow
|
45
|
+
puts_color 'Something.', :blue
|
46
|
+
|
47
|
+
#
|
48
|
+
# puts_color shorthand methods also available
|
49
|
+
#
|
50
|
+
|
51
|
+
puts_color_red 'Red'
|
52
|
+
puts_color_purple 'Purple'
|
53
|
+
puts_color_cyan 'Cyan'
|
54
|
+
puts_color_gray 'Grey'
|
55
|
+
puts_color_blue 'Blue'
|
56
|
+
puts_color_yellow 'Yellow'
|
57
|
+
puts_color_green 'Green'
|
58
|
+
|
59
|
+
#
|
60
|
+
# Use puts_prompt to ask for inputs
|
61
|
+
#
|
62
|
+
|
63
|
+
color = puts_prompt "What's your favourite colour?: ", required: true
|
64
|
+
|
65
|
+
puts_color "You answered '#{color}'!", color.to_sym
|
66
|
+
|
67
|
+
#
|
68
|
+
# Use puts_table to display tabular data
|
69
|
+
#
|
70
|
+
|
71
|
+
puts_table %w[Color Code] do
|
72
|
+
PutsUtils::PutsColor::COLOR_CODES.map do |color, code|
|
73
|
+
[color, code]
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
```
|
79
|
+
|
80
|
+
## License
|
81
|
+
|
82
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
83
|
+
|
84
|
+
## Code of Conduct
|
85
|
+
|
86
|
+
Everyone interacting in the PutsUtils project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/puts_utils/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "puts_utils"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/lib/puts_utils.rb
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module PutsUtils
|
4
|
+
module PutsColor
|
5
|
+
COLOR_CODES = {
|
6
|
+
red: 31,
|
7
|
+
green: 32,
|
8
|
+
yellow: 33,
|
9
|
+
blue: 34,
|
10
|
+
purple: 35,
|
11
|
+
cyan: 36,
|
12
|
+
gray: 37
|
13
|
+
}.freeze
|
14
|
+
|
15
|
+
def puts_color(string, color = :gray)
|
16
|
+
puts "\e[#{COLOR_CODES[color]}m#{string}\e[0m"
|
17
|
+
end
|
18
|
+
|
19
|
+
COLOR_CODES.keys.each do |color|
|
20
|
+
define_method "puts_color_#{color}" do |string|
|
21
|
+
puts_color string, color
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module PutsUtils
|
4
|
+
module PutsPrompt
|
5
|
+
# rubocop: disable Metrics/CyclomaticComplexity
|
6
|
+
# rubocop: disable Metrics/MethodLength
|
7
|
+
def puts_prompt(question, required: false, default: nil)
|
8
|
+
tries = 1
|
9
|
+
loop do
|
10
|
+
STDOUT.print question
|
11
|
+
answer = STDIN.gets.strip
|
12
|
+
return answer if answer.present?
|
13
|
+
return default if answer.empty? && required == false
|
14
|
+
raise 'Value is required' if answer.empty? && required && tries == 3
|
15
|
+
|
16
|
+
puts 'Sorry, this is required – please try again'
|
17
|
+
tries += 1
|
18
|
+
next
|
19
|
+
end
|
20
|
+
end
|
21
|
+
# rubocop: enable Metrics/CyclomaticComplexity
|
22
|
+
# rubocop: enable Metrics/MethodLength
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'puts_utils/puts_table/formatter'
|
4
|
+
require 'puts_utils/puts_table/table'
|
5
|
+
|
6
|
+
module PutsUtils
|
7
|
+
module PutsTable
|
8
|
+
def puts_table(headers = nil, data = nil)
|
9
|
+
data = yield if block_given?
|
10
|
+
table = Table.new(headers, data)
|
11
|
+
puts Formatter.new(table).to_s
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module PutsUtils
|
4
|
+
module PutsTable
|
5
|
+
class Formatter
|
6
|
+
attr_reader :table
|
7
|
+
|
8
|
+
def initialize(table)
|
9
|
+
@table = table
|
10
|
+
@sizes = {}
|
11
|
+
end
|
12
|
+
|
13
|
+
def to_s
|
14
|
+
table.rows.map do |values|
|
15
|
+
render_row(values)
|
16
|
+
end.join("\n")
|
17
|
+
end
|
18
|
+
|
19
|
+
private
|
20
|
+
|
21
|
+
def render_row(values)
|
22
|
+
(+'').tap do |result|
|
23
|
+
values.each_with_index do |value, column|
|
24
|
+
result << format("%-#{size_of_column(column)}s\t", value)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
def size_of_column(index)
|
30
|
+
key = index.to_s.to_sym
|
31
|
+
return @sizes[key] if @sizes.key?(key)
|
32
|
+
|
33
|
+
@sizes[key] = table.column(index)
|
34
|
+
.map(&:to_s)
|
35
|
+
.max_by(&:length)
|
36
|
+
.length
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module PutsUtils
|
4
|
+
module PutsTable
|
5
|
+
class Table
|
6
|
+
def initialize(headers, data)
|
7
|
+
@headers = headers || []
|
8
|
+
@data = data || []
|
9
|
+
@columns = {}
|
10
|
+
end
|
11
|
+
|
12
|
+
def rows
|
13
|
+
@rows ||= [@headers] + @data
|
14
|
+
end
|
15
|
+
|
16
|
+
def column(index)
|
17
|
+
key = index.to_s.to_sym
|
18
|
+
return @columns[key] if @columns.key?(key)
|
19
|
+
|
20
|
+
@columns[key] = rows.map { |r| r[index] }
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
data/puts_utils.gemspec
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
lib = File.expand_path('lib', __dir__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
require 'puts_utils/version'
|
6
|
+
|
7
|
+
Gem::Specification.new do |spec|
|
8
|
+
spec.name = 'puts_utils'
|
9
|
+
spec.version = PutsUtils::VERSION
|
10
|
+
spec.authors = ['Collaboration Collective']
|
11
|
+
spec.email = ['hello@collabcollective.com']
|
12
|
+
|
13
|
+
spec.summary = 'Prettier puts formatting for the lazy'
|
14
|
+
spec.description = 'Helpful utilities to puts in colour, tables and more.'
|
15
|
+
spec.homepage = 'https://github.com/collcoll/puts_utils'
|
16
|
+
spec.license = 'MIT'
|
17
|
+
|
18
|
+
spec.metadata['homepage_uri'] = spec.homepage
|
19
|
+
spec.metadata['source_code_uri'] = spec.homepage
|
20
|
+
|
21
|
+
# Specify which files should be added to the gem when it is released.
|
22
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
23
|
+
spec.files = Dir.chdir(File.expand_path(__dir__)) do
|
24
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
25
|
+
end
|
26
|
+
spec.bindir = 'exe'
|
27
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
28
|
+
spec.require_paths = ['lib']
|
29
|
+
|
30
|
+
spec.add_development_dependency 'bundler', '~> 2.0'
|
31
|
+
spec.add_development_dependency 'minitest', '~> 5.0'
|
32
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
33
|
+
spec.add_development_dependency 'rubocop', '~> 0.76'
|
34
|
+
end
|
metadata
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: puts_utils
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Collaboration Collective
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-11-25 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: '2.0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '2.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: minitest
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '5.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '5.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rubocop
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0.76'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0.76'
|
69
|
+
description: Helpful utilities to puts in colour, tables and more.
|
70
|
+
email:
|
71
|
+
- hello@collabcollective.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rubocop.yml"
|
78
|
+
- ".travis.yml"
|
79
|
+
- CODE_OF_CONDUCT.md
|
80
|
+
- Gemfile
|
81
|
+
- LICENSE.txt
|
82
|
+
- README.md
|
83
|
+
- Rakefile
|
84
|
+
- bin/console
|
85
|
+
- bin/setup
|
86
|
+
- lib/puts_utils.rb
|
87
|
+
- lib/puts_utils/puts_color.rb
|
88
|
+
- lib/puts_utils/puts_prompt.rb
|
89
|
+
- lib/puts_utils/puts_table.rb
|
90
|
+
- lib/puts_utils/puts_table/formatter.rb
|
91
|
+
- lib/puts_utils/puts_table/table.rb
|
92
|
+
- lib/puts_utils/version.rb
|
93
|
+
- puts_utils.gemspec
|
94
|
+
homepage: https://github.com/collcoll/puts_utils
|
95
|
+
licenses:
|
96
|
+
- MIT
|
97
|
+
metadata:
|
98
|
+
homepage_uri: https://github.com/collcoll/puts_utils
|
99
|
+
source_code_uri: https://github.com/collcoll/puts_utils
|
100
|
+
post_install_message:
|
101
|
+
rdoc_options: []
|
102
|
+
require_paths:
|
103
|
+
- lib
|
104
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - ">="
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: '0'
|
109
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
110
|
+
requirements:
|
111
|
+
- - ">="
|
112
|
+
- !ruby/object:Gem::Version
|
113
|
+
version: '0'
|
114
|
+
requirements: []
|
115
|
+
rubygems_version: 3.0.3
|
116
|
+
signing_key:
|
117
|
+
specification_version: 4
|
118
|
+
summary: Prettier puts formatting for the lazy
|
119
|
+
test_files: []
|