sai 0.1.0 → 0.3.0

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.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/CHANGELOG.md +32 -1
  4. data/README.md +32 -209
  5. data/docs/USAGE.md +303 -0
  6. data/lib/sai/ansi/sequence_processor.rb +380 -0
  7. data/lib/sai/ansi/sequenced_string.rb +475 -0
  8. data/lib/sai/ansi.rb +5 -5
  9. data/lib/sai/conversion/color_sequence.rb +31 -31
  10. data/lib/sai/conversion/rgb.rb +17 -17
  11. data/lib/sai/decorator.rb +256 -240
  12. data/lib/sai/mode_selector.rb +298 -0
  13. data/lib/sai/support.rb +99 -98
  14. data/lib/sai/terminal/capabilities.rb +22 -22
  15. data/lib/sai/terminal/color_mode.rb +7 -7
  16. data/lib/sai.rb +128 -77
  17. data/sig/manifest.yaml +3 -0
  18. data/sig/sai/ansi/sequence_processor.rbs +253 -0
  19. data/sig/sai/ansi/sequenced_string.rbs +380 -0
  20. data/sig/sai/ansi.rbs +5 -5
  21. data/sig/sai/conversion/color_sequence.rbs +21 -21
  22. data/sig/sai/conversion/rgb.rbs +17 -17
  23. data/sig/sai/decorator.rbs +111 -87
  24. data/sig/sai/mode_selector.rbs +319 -0
  25. data/sig/sai/support.rbs +50 -37
  26. data/sig/sai/terminal/capabilities.rbs +16 -16
  27. data/sig/sai/terminal/color_mode.rbs +7 -7
  28. data/sig/sai.rbs +109 -66
  29. metadata +12 -4
data/lib/sai/conversion/rgb.rb CHANGED
@@ -7,7 +7,7 @@ module Sai
7
7
  # RGB color conversion utilities
8
8
  #
9
9
  # @author {https://aaronmallen.me Aaron Allen}
10
- # @since unreleased
10
+ # @since 0.1.0
11
11
  #
12
12
  # @api private
13
13
  module RGB
@@ -15,7 +15,7 @@ module Sai
15
15
  # Get closest ANSI color for RGB values
16
16
  #
17
17
  # @author {https://aaronmallen.me Aaron Allen}
18
- # @since unreleased
18
+ # @since 0.1.0
19
19
  #
20
20
  # @api private
21
21
  #
@@ -37,7 +37,7 @@ module Sai
37
37
  # Determine if a color is dark
38
38
  #
39
39
  # @author {https://aaronmallen.me Aaron Allen}
40
- # @since unreleased
40
+ # @since 0.1.0
41
41
  #
42
42
  # @api private
43
43
  #
@@ -54,7 +54,7 @@ module Sai
54
54
  # Determine if a color is grayscale
55
55
  #
56
56
  # @author {https://aaronmallen.me Aaron Allen}
57
- # @since unreleased
57
+ # @since 0.1.0
58
58
  #
59
59
  # @api private
60
60
  #
@@ -71,7 +71,7 @@ module Sai
71
71
  # Convert a color value to RGB components
72
72
  #
73
73
  # @author {https://aaronmallen.me Aaron Allen}
74
- # @since unreleased
74
+ # @since 0.1.0
75
75
  #
76
76
  # @api private
77
77
  #
@@ -96,7 +96,7 @@ module Sai
96
96
  # Convert RGB values to 256-color cube index
97
97
  #
98
98
  # @author {https://aaronmallen.me Aaron Allen}
99
- # @since unreleased
99
+ # @since 0.1.0
100
100
  #
101
101
  # @api private
102
102
  #
@@ -112,7 +112,7 @@ module Sai
112
112
  # Convert RGB values to grayscale index
113
113
  #
114
114
  # @author {https://aaronmallen.me Aaron Allen}
115
- # @since unreleased
115
+ # @since 0.1.0
116
116
  #
117
117
  # @api private
118
118
  #
@@ -129,7 +129,7 @@ module Sai
129
129
  # Check if RGB values represent cyan
130
130
  #
131
131
  # @author {https://aaronmallen.me Aaron Allen}
132
- # @since unreleased
132
+ # @since 0.1.0
133
133
  #
134
134
  # @api private
135
135
  #
@@ -146,7 +146,7 @@ module Sai
146
146
  # Convert a hex string to RGB values
147
147
  #
148
148
  # @author {https://aaronmallen.me Aaron Allen}
149
- # @since unreleased
149
+ # @since 0.1.0
150
150
  #
151
151
  # @api private
152
152
  #
@@ -166,7 +166,7 @@ module Sai
166
166
  # Check if RGB values represent magenta
167
167
  #
168
168
  # @author {https://aaronmallen.me Aaron Allen}
169
- # @since unreleased
169
+ # @since 0.1.0
170
170
  #
171
171
  # @api private
172
172
  #
@@ -183,7 +183,7 @@ module Sai
183
183
  # Convert a named color to RGB values
184
184
  #
185
185
  # @author {https://aaronmallen.me Aaron Allen}
186
- # @since unreleased
186
+ # @since 0.1.0
187
187
  #
188
188
  # @api private
189
189
  #
@@ -201,7 +201,7 @@ module Sai
201
201
  # Determine if RGB values represent a primary color
202
202
  #
203
203
  # @author {https://aaronmallen.me Aaron Allen}
204
- # @since unreleased
204
+ # @since 0.1.0
205
205
  #
206
206
  # @api private
207
207
  #
@@ -220,7 +220,7 @@ module Sai
220
220
  # Get the closest primary color
221
221
  #
222
222
  # @author {https://aaronmallen.me Aaron Allen}
223
- # @since unreleased
223
+ # @since 0.1.0
224
224
  #
225
225
  # @api private
226
226
  #
@@ -242,7 +242,7 @@ module Sai
242
242
  # Determine if RGB values represent a secondary color
243
243
  #
244
244
  # @author {https://aaronmallen.me Aaron Allen}
245
- # @since unreleased
245
+ # @since 0.1.0
246
246
  #
247
247
  # @api private
248
248
  #
@@ -263,7 +263,7 @@ module Sai
263
263
  # Get the closest secondary color
264
264
  #
265
265
  # @author {https://aaronmallen.me Aaron Allen}
266
- # @since unreleased
266
+ # @since 0.1.0
267
267
  #
268
268
  # @api private
269
269
  #
@@ -284,7 +284,7 @@ module Sai
284
284
  # Validate RGB values
285
285
  #
286
286
  # @author {https://aaronmallen.me Aaron Allen}
287
- # @since unreleased
287
+ # @since 0.1.0
288
288
  #
289
289
  # @api private
290
290
  #
@@ -303,7 +303,7 @@ module Sai
303
303
  # Check if RGB values represent yellow
304
304
  #
305
305
  # @author {https://aaronmallen.me Aaron Allen}
306
- # @since unreleased
306
+ # @since 0.1.0
307
307
  #
308
308
  # @api private
309
309
  #