term_color 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ce5c2c4c91c5840b4fed9d6147fe77345dd6ea5533f350c0d5f3e3744cea7b
-  data.tar.gz: 46eb95a0bd5f3a5357900b4e5897b3385e8f1d3fbc8a9a550139f7c4ffdc93a2
+  metadata.gz: a5c5c053cd07cea1249b693d74cd9f0bb063b0c2be81e4ca8ee50c1e43789273
+  data.tar.gz: 2db955626d5da3fd4d5299a36487c854c8f2386ce0d332589bc73694551cc256
 SHA512:
-  metadata.gz: f78fa2b93f8175663f6c6fec99bf696a7c4dc6f8f3579de727b1bfc6d313705572499d2d159b3613539dbac4694e078fd42e8c44f1bcf3592e33d8bdc98bc8e7
-  data.tar.gz: 9f2b1fdc0ca6afdb631fc38b9ff331cd5f7913b5f354e10c6b75b8a5d34b2e2653e7fa3847d5aadaeba4bf03f2beb67c7e69a5f1fdd9a8dba1fce37ff71214f8
+  metadata.gz: 8755f513658b1233352886f93325de9dc84f393f4509cc46b9cd29815ef81a1ed0c59749f2468d89edf5944aa6b763e3d7a5cbb5ca8cfc3b85e79ebb64c164e8
+  data.tar.gz: 7d852dc156d2c00483142547cb24add1d252a42b9ad3e994ace9bf72c41da66d95633ed6ae3876e4209a4d7c09c20a560f4a00a776d299324957b9537001d2bd

data/README.md

@@ -93,37 +93,71 @@ r = { fg: :red, bg: :blue }
 r = { after: { reset: :all}  }
 ```
 
-### Rule Options/Actions
+## Rule Parts/Actions
 
-#### Colors
+Option parts / actions available to rule definitions.
 
-##### Attributes
+### Colors
+
+#### Attributes
 
 - `fg` - Change foreground color
 - `bg` - Change background color
 
-##### Values
+#### Values
+
+_If images don't show up, try viewing on [Github](https://github.com/vdtdev/term_color/blob/master/README.md)_
+
+##### Standard Named Colors
+
+Color values can be color-name symbols as defined in {TermColor::Rule::Colors Rule::Colors} (`:black, :red, :yellow, :blue, :magenta, :cyan, :white, :bright_black, :bright_red, :bright_yellow, :bright_blue, :bright_magenta, :bright_cyan, :bright_white`)
 
-###### Standard Named Colors
+```ruby
+rs = TermColor.create_rule_set({
+    named: { fg: :yellow, bg: :blue }
+})
+rs.print "Before {%namedHello!%}\n"
+```
 
-Color values can be color-name symbols as defined in {TermColor::Rule::Colors} (`:black, :red, :yellow, :blue, :magenta, :cyan, :white`)
+![](./docs/colors_named.png)
+![](./file/docs/colors_named.png)
 
-###### XTerm 256 Color Values
+##### XTerm 256 Color Values
 
 To use XTerm 256 Color Mode values, include the color code integer inside a single item array. (E.g. for code `208`, use `[208]`)
 
-###### XTerm 16m Color Values
+```ruby
+rs = TermColor.create_rule_set({
+    x256: { fg: [226], bg: [56] }
+})
+rs.print "Before {%x256Hello!%}\n"
+```
+
+![](./docs/colors_256.png)
+![](./file/docs/colors_256.png)
+
+##### XTerm 16m Color Values
 
 To use XTerm 16m Color Mode RGB colors, include the red, green and blue color values in an ordered array (E.g. for 80 red, 80 green, 255 blue, use `[80,80,255]`)
 
-#### Styles
+```ruby
+rs = TermColor.create_rule_set({
+    x16: { fg: [255,250,11], bg: [15,15,200] }
+})
+rs.print "Before {%x16Hello!%}\n"
+```
+
+![](./docs/colors_16m.png)
+![](./file/docs/colors_16m.png)
 
-##### Actions
+### Styles
+
+#### Actions
 
 - `enable` - Style(s) to enable (Can be single item or array)
 - `disable` - Style(s) to disable (Can be single item or array)
 
-##### Values
+#### Values
 
 (See symbols in {TermColor::Rule::Styles})
 
@@ -135,7 +169,7 @@ To use XTerm 16m Color Mode RGB colors, include the red, green and blue color va
 - `:hidden`
 - `:strikethrough`
 
-#### Reset / Keep
+### Reset / Keep
 
 _(Only valid in `after` section)_
 
@@ -154,8 +188,6 @@ Quick way of resetting one or more style rules. `reset`/`keep` can be given a si
 - `:style` - Reset all styling
 - `:all` - Reset all colors and styling
 
-[If example images are missing, view readme on github](https://github.com/vdtdev/term_color/blob/master/README.md)
-
 ## Examples
 
 _If images don't show up, try viewing on [Github](https://github.com/vdtdev/term_color/blob/master/README.md)_

data/lib/term_color/rule.rb

@@ -39,10 +39,18 @@ module TermColor
             blue: 4,
             magenta: 5,
             cyan: 6,
-            white: 7
+            white: 7,
+            bright_black: 60,
+            bright_red: 61,
+            bright_green: 62,
+            bright_yellow: 63,
+            bright_blue: 64,
+            bright_magenta: 65,
+            bright_cyan: 66,
+            bright_white: 67
         }.freeze
 
-                ##
+        ##
         # Numerical modifiers used with Color Values
         # to target foreground or background.
         #
@@ -240,6 +248,30 @@ module TermColor
             codes = codes.flatten.compact.uniq
         end
 
+        ##
+        # Resolve named color, allowing fg target colors
+        # to use names prefixed with `light_` (e.g. `:light_blue`)
+        # def resolve_named_color(color, target = :fg)
+        #     sym = color.to_sym
+        #     unless target == :fg
+        #         # strip out any light_ prefix if not targetting :fg
+        #         sym = (sym.to_s.gsub('light_','')).to_sym
+        #     end
+        #     if Colors.has_key?(sym)
+        #         # Name found, return value + fg target 
+        #         return [Colors[sym].to_i]
+        #     end
+        #     pre,name = sym.to_s.split("_")
+        #     if pre == 'light' && !name.nil? && Colors.has_key?(name.to_sym)
+        #         # Named color with 'light_' prefix
+        #         # Return color code along with Proc to format with "1;val"
+        #         return [Colors[name.to_sym].to_i, Proc.new {|c| "1;#{c}" }]
+        #     end
+            
+        #     # Give back 0 if not resolved
+        #     return 0
+        # end
+
         def resolve_color(color, target = :fg)
             if color.is_a?(Array)
                 color = color[0..2]
@@ -253,7 +285,7 @@ module TermColor
                 end
                 color = Colors[color.to_sym].to_i
             end
-            (color + ColorTargets[target.to_sym].to_i)
+            color + ColorTargets[target.to_sym].to_i
         end
 
         def resolve_style(style, state = :enable)
@@ -339,6 +371,15 @@ module TermColor
             return parts.merge({evaluated: true})
         end
 
+        ##
+        # Normalize a rule's part, making sure all possible keys
+        # exist with at least `nil` values, and values that can be arrays
+        # are at least empty arrays, or arrays containing singular value
+        # @param [Hash] hash Input part to normalize
+        # @param [Symbol] part Which part to normalize {TermColor::Rule::PartOps}
+        # @param [Boolean] clean If true, strip out all values that are nil
+        #   or empty arrays (default `false`)
+        # @return [Hash] Copy of input hash after normalization is applied
         def normalize_part(hash,part,clean=false)
             h = hash.dup
             PartOps[part].each do |o|
@@ -356,6 +397,17 @@ module TermColor
             return h
         end
         
+        ##
+        # Combine an 'override' version of a rule's after part with a
+        # default 'after' part, resulting in the original default 'after' part
+        # with any adjustments needed to apply rules from override
+        # @param [Hash] inside 'Inside' part of rule, used to expand
+        #   `reset: :style` into specific `disable`
+        # @param [Hash] override Override version of after to apply to given
+        #   default
+        # @param [Hash] after Default 'after' part to be overridden
+        # @return [Hash] Overridden version of after rules
+        # @see normalize_part
         def override_after(inside, override, after)
             c_ovr = normalize_part(override, :after)
             c_aft = normalize_part(after, :after)
@@ -414,9 +466,18 @@ module TermColor
             return normalize_part(result, :after, true)
         end
         
+        ##
+        # Build after rule automatically based on inside portion of
+        # rule, treating given existing explict 'after' rules as overrides
+        # @param [Hash] inside Inside portion of rule to generate after for
+        # @param [Hash] after Explicitly defined after section of source rule,
+        #   combined with result by treating as overrides
+        # @return [Hash] Generated 'after' rules
         def build_auto_after(inside, after={})
             c_inside = normalize_part(inside, :inside)
-            n_after = normalize_part({}, :after)
+            # n_after = normalize_part({}, :after)
+            # TODO: Test to make sure the below fixed line doesn't break stuff :)
+            n_after = normalize_part(after, :after)
             
             if c_inside[:enable].length > 0
                 n_after[:reset] += [:style]
@@ -428,7 +489,8 @@ module TermColor
                 end
             end
 
-            override_after(inside, after, n_after)
+            # Combine override after section
+            rules = override_after(inside, after, n_after)
         end
 
         ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: term_color
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Wade H.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -46,7 +46,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/vdtdev/term_color
-  documentation_uri: https://rubydoc.info/gems/term_color/0.1.0
+  documentation_uri: https://rubydoc.info/gems/term_color/0.1.1
 post_install_message: 
 rdoc_options: []
 require_paths: