Module: Colours::BasicColours

Included in:
Foo
Defined in:
lib/colours/basic_colours/basic_colours.rb

Overview

Colours::BasicColours

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
const_get(inspect)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.black(i = '') ⇒ Object

#

Colours.black

#

227
228
229
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 227

def self.black(i = '')
  "#{COLOUR_BLACK}#{i}#{REVERT}"
end

.blue(i = '') ⇒ Object

#

Colours.blue

#

145
146
147
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 145

def self.blue(i = '')
  "#{COLOUR_BLUE}#{i}#{REVERT}"
end

.brown(i = '') ⇒ Object

#

Colours.brown

#

212
213
214
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 212

def self.brown(i = '')
  "#{COLOUR_BROWN}#{i}#{REVERT}"
end

.cyan(i = '') ⇒ Object

#

Colours.cyan

#

28
29
30
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 28

def self.cyan(i = '')
  "#{COLOUR_CYAN}#{i}#{REVERT}"
end

.dark_gray(i = '') ⇒ Object

#

Colours.dark_gray

#

243
244
245
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 243

def self.dark_gray(i = '')
  "#{COLOUR_DARK_GRAY}#{i}#{REVERT}"
end

.define_colour_methods_that_can_be_included ⇒ Object

#

Colours.define_colour_methods_that_can_be_included

Dynamic definitions of some methods, such as teal() or red() or white() or bold_white() or lightblue(). These will be defined at include-time, meaning that they will only be available if you do “include Colours”.

Should come up very early in the definition, as other methods may depend on it.

To test this, try:

Colours.bold_yellow('hey joe')
#

272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 272

def self.define_colour_methods_that_can_be_included
  all_colours = ::Colours.really_all_colours
  # ======================================================================= #
  # The above refers to an Array that looks like this:
  #
  #   [ :black, :red, :green, :yellow, :blue, :magenta, :teal,
  #     :white, :bright_black, :bright_red, :bright_green,
  #     :bright_yellow, :bright_blue, :bright_magenta,
  #     :bright_cyan, :bright_white]
  #
  # ======================================================================= #
  all_colours.each {|entry|
    unless defined? entry.to_sym # Must prevent re-definitions here.
      define_method(entry.to_sym) {|i = ''| # Allow input.
        i = i.to_s
        _ = ''.dup
        _ << "#{map_colour_to_constant(__method__)}"
        _ << "#{i}#{rev}" unless i.empty?
        return _
      }
    end
  }
end

.green(i = '') ⇒ Object

#

Colours.green

#

205
206
207
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 205

def self.green(i = '')
  "#{COLOUR_GREEN}#{i}#{REVERT}"
end

.grey(i = '') ⇒ Object

#

Colours.grey

#

42
43
44
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 42

def self.grey(i = '')
  "#{COLOUR_GRAY}#{i}#{REVERT}"
end

.light_blue(i = '') ⇒ Object

#

Colours.light_blue

#

86
87
88
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 86

def self.light_blue(i = '')
  "#{COLOUR_LIGHT_BLUE}#{i}#{REVERT}"
end

.light_cyan(i = '') ⇒ Object

#

Colours.light_cyan

#

220
221
222
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 220

def self.light_cyan(i = '')
  "#{COLOUR_LIGHT_CYAN}#{i}#{REVERT}"
end

.light_gray(i = '') ⇒ Object

#

Colours.light_gray

#

234
235
236
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 234

def self.light_gray(i = '')
  "#{COLOUR_LIGHT_GRAY}#{i}#{REVERT}"
end

.light_green(i = '') ⇒ Object

#

Colours.light_green

#

116
117
118
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 116

def self.light_green(i = '')
  "#{COLOUR_LIGHT_GREEN}#{i}#{REVERT}"
end

.light_magenta(i = '') ⇒ Object

#

Colours.light_magenta

#

166
167
168
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 166

def self.light_magenta(i = '')
  "#{COLOUR_LIGHT_MAGENTA}#{i}#{REVERT}"
end

.light_red(i = '') ⇒ Object

#

Colours.light_red

#

70
71
72
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 70

def self.light_red(i = '')
  "#{COLOUR_LIGHT_RED}#{i}#{REVERT}"
end

.magenta(i = '') ⇒ Object

#

Colours.magenta

#

102
103
104
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 102

def self.magenta(i = '')
  "#{COLOUR_MAGENTA}#{i}#{REVERT}"
end

.red(i = '') ⇒ Object

#

Colours.red

#

131
132
133
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 131

def self.red(i = '')
  "#{COLOUR_RED}#{i}#{REVERT}"
end

.white(i = '') ⇒ Object

#

Colours::BasicColours.white

#

56
57
58
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 56

def self.white(i = '')
  "#{COLOUR_WHITE}#{i}#{REVERT}"
end

.yellow(i = '') ⇒ Object

#

Colours.yellow

#

181
182
183
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 181

def self.yellow(i = '')
  "#{COLOUR_YELLOW}#{i}#{REVERT}"
end

Instance Method Details

#blue(i = '') ⇒ Object

#

blue

#

152
153
154
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 152

def blue(i = '')
  NAMESPACE.blue(i)
end

#bold_green(i = '') ⇒ Object Also known as: greenb

#

bold_green

#

124
125
126
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 124

def bold_green(i = '')
  ::NAMESPACE.bold_green(i)
end

#bold_red(i = '') ⇒ Object Also known as: lightred, redb

#

bold_red

#

78
79
80
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 78

def bold_red(i = '')
  NAMESPACE.bold_red(i)
end

#bold_white(i = '') ⇒ Object Also known as: whiteb

#

bold_white

#

63
64
65
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 63

def bold_white(i = '')
  NAMESPACE.bold_white(i)
end

#bold_yellow(i = '') ⇒ Object Also known as: yelb

#

bold_yellow

#

252
253
254
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 252

def bold_yellow(i = '')
  NAMESPACE.bold_yellow(i)
end

#cyan(i = '') ⇒ Object

#

cyan

#

35
36
37
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 35

def cyan(i = '')
  NAMESPACE.cyan(i)
end

#grey(i = '') ⇒ Object Also known as: gray

#

grey

#

49
50
51
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 49

def grey(i = '')
  NAMESPACE.grey(i)
end

#light_blue(i = '') ⇒ Object Also known as: lightblue, bold_blue

#

light_blue

#

94
95
96
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 94

def light_blue(i = '')
  NAMESPACE.light_blue(i)
end

#light_green(i = '') ⇒ Object

#

light_green

#

159
160
161
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 159

def light_green(i = '')
  NAMESPACE.light_green(i)
end

#light_magenta(i = '') ⇒ Object

#

light_magenta

#

174
175
176
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 174

def light_magenta(i = '')
  NAMESPACE.light_magenta(i)
end

#light_red(i = '') ⇒ Object

#

light_red

#

198
199
200
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 198

def light_red(i = '')
  NAMESPACE.light_red(i)
end

#magenta(i = '') ⇒ Object Also known as: purple

#

magenta

#

109
110
111
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 109

def magenta(i = '')
  NAMESPACE.magenta(i)
end

#red(i = '') ⇒ Object

#

red

#

138
139
140
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 138

def red(i = '')
  NAMESPACE.red(i)
end

#yellow(i = '') ⇒ Object Also known as: brown, yel, bold_brown

#

yellow

#

189
190
191
 
# File 'lib/colours/basic_colours/basic_colours.rb', line 189

def yellow(i = '')
  NAMESPACE.yellow(i)
end