1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# Paint::SHORTCUTS [<img src="https://badge.fury.io/rb/paint-shortcuts.svg" />](https://badge.fury.io/rb/paint-shortcuts)
This is an optional extension gem for [Paint](https://github.com/janlelis/paint)
## Setup
Add to `Gemfile`:
gem 'paint-shortcuts'
and run `bundle install`.
In Ruby do:
require 'paint/shortcuts'
## Description
You can create color shortcuts for your gems and scripts! Please note: You don't have to use this feature (and only stick to `Paint.[]` instead)
All you need to do is to setup a hash of symbol keys and escaped color sequences at:
`Paint::SHORTCUTS[:your_namespace]`:
```ruby
Paint::SHORTCUTS[:example] = {
:white => Paint.color(:black),
:red => Paint.color(:red, :bright),
:title => Paint.color(:underline),
}
```
The methods become "rubymagically" available in a `Paint` child model:
```ruby
Paint::Example.red 'Ruby' # => "\e[31;1mRuby\e[0m"
Paint::Example.white # => "\e[37m"
```
As you can see, the helper methods look useful and can take either one (wrap string) or none (only color) arguments. You can also include them:
```ruby
include Paint::Example
red # => "\e[31;1m"
white 'Ruby' # => "\e[30m"
```
All shortcuts, defined in your shortcut namespace at this time, are now (privately) available in your current namespace (without relying a `method_missing` implementation).
Furthermore, there are variations of this approach. You get a different behaviour, when you include the `String` sub-module.
```ruby
include Paint::Example::String
"Ruby".title # => "\e[4mRuby\e[0m"
5.red # => "\e[31;1m5\e[0m"
```
In this case, `self` will be converted to a string and wrapped with the specific color code. Note, that the helper methods don't take any arguments when using this style of inclusion.
The third way allows you to get a single color helper method to avoid cluttering namespaces:
```ruby
include Paint::Example::Prefix::ExampleName
"Ruby".example_name(:red) # => "\e[31;1mRuby\e[0m"
```
|
