Module: Broken

Defined in:
lib/broken.rb,
lib/config.rb

Defined Under Namespace

Classes: Config

Constant Summary collapse

@@pastel = 
Pastel.new
@@config = 
Config.new
@@is_prying = 
false

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.configure {|@@config| ... } ⇒ Object

Override config from application.

Yields:

  • (@@config) 


177
178
179
180
181
182
 
# File 'lib/broken.rb', line 177

def self.configure()
  yield(@@config)

  # Override config from flags on command line.
  @@config.cli_configure()
end

.delay ⇒ Object 



109
110
111
112
113
 
# File 'lib/broken.rb', line 109

def self.delay()
  if @@config.delay > 0
    sleep(@@config.delay)
  end
end

.filter_status?(status) ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
96
97
98
99
 
# File 'lib/broken.rb', line 93

def self.filter_status? status
  unless @@config.status.nil? || @@config.status.include?(status)
    return true
  end

  false
end

.filter_type?(type) ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
104
105
106
107
 
# File 'lib/broken.rb', line 101

def self.filter_type? type
  unless @@config.type.nil? || @@config.type.include?(type)
    return true
  end

  false
end

.format(text, config) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/broken.rb', line 119

def self.format(text, config)

  if config.has_key? :styles
    # Change characters first.
    config[:styles].each do |style|
      case style
      when :upcase
        text = text.upcase
      when :downcase
        text = text.downcase
      when :capitalize
        text = text.capitalize
      end
    end
    # Then apply styling.
    config[:styles].each do |style|
      case style
      when :clear
        text = @@pastel.clear(text)
      when :bold
        text = @@pastel.bold(text)
      when :dim
        text = @@pastel.dim(text)
      when :italic
        text = @@pastel.italic(text)
      when :underline
        text = @@pastel.underline(text)
      when :inverse
        text = @@pastel.inverse(text)
      when :hidden
        text = @@pastel.hidden(text)
      when :strike, :strikethrough
        text = @@pastel.strikethrough(text)
      end
    end
  end

  if config.has_key? :color
    case config[:color]
    when :blue
      text = @@pastel.bright_blue(text)
    when :green
      text = @@pastel.green(text)
    when :yellow
      text = @@pastel.yellow(text)
    when :red
      text = @@pastel.red(text)
    when :purple, :magenta
      text = @@pastel.magenta(text)
    when :cyan
      text = @@pastel.cyan(text)
    end
  end

  text
end

.is_prying? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/broken.rb', line 115

def self.is_prying?
  @@config.step && @@is_prying
end

.render(message, status, type, context) ⇒ Object 



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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/broken.rb', line 24

def self.render(message, status, type, context)
  output = "🔥"

  # Time.
  time = Broken.format(Time.now().strftime("%k:%M"), color: :cyan)
  output << " #{time}"

  # Status.
  config = @@config.statuses[status]
  output << Broken.format(" #{config[:icon]} #{status.to_s}", config)

  # Type.
  if !@@config.types.nil? && @@config.types.has_key?(type)
    config = @@config.types[type]
    if config.has_key? :icon
      output << Broken.format(" #{config[:icon]} #{type.to_s}", config)
    else
      output << Broken.format(" #{type.to_s}", config)
    end
  end

  # Context.
  output << Broken.format(" #{context}", styles: [:bold, :dim])

  # Line break.
  while message.start_with?('^')
    message.delete_prefix!('^').strip!
    unless @@config.status || @@config.type
      output = "\n" + output
    end
  end

  # Indent.
  indent = ''
  while message.start_with?('>')
    message.delete_prefix!('>').strip!
    unless @@config.status || @@config.type
      indent = indent + '  '
      output = '  ' + output
    end
  end

  # Highlight numbers and methods.
  words = []
  message.split(/(#\d+|\w+\(\))/).each do |word|
    if word.start_with?('#') || word.end_with?(')')
      words << @@pastel.yellow(word)
    else
      words << word
    end
  end

  puts output << " " + words.join()

  return indent
end

.step(indent) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/broken.rb', line 81

def self.step(indent)
  if @@config.step
    puts "#{indent}🔥 Press ENTER to step or P to Pry:"
    input = gets.chomp
    binding while input == nil
    if input.downcase == "p"
      puts @@pastel.dim("Enter X to exit Pry or !!! to exit program.")
      @@is_prying = true
    end
  end
end

Instance Method Details

#broken(message, status = :info, type = nil, context = nil) ⇒ Object Also known as: 🔥 



9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/broken.rb', line 9

def broken(message, status = :info, type = nil, context = nil)
  if @@config.enabled
    return if Broken.filter_status? status
    return if Broken.filter_type? type

    indent = Broken.render(message, status, type, context)

    Broken.step(indent)
    yield if block_given?

    Broken.delay()
  end
end