l43_color 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18a2fda2e427986f245d7010c46ff932376a35ca198e5dae6bd7acacabc25d98
-  data.tar.gz: 43432648858186ec32e661495a7b31e2bd790a6f15e59e81c20b6cedea894057
+  metadata.gz: ebccf614bfe1b82244f4f6ace438402fac68bef6df5a4509c266bc45f415b249
+  data.tar.gz: ff2b98d1a9b42ac04e67154ace1eed41f13f0961ac6edb617aa3c508884e8542
 SHA512:
-  metadata.gz: 5c5007be7b175721c80f6520962232667f226bd389fc970c4500681aeec8d93df81b22fd57aecbc70e9d41110f22d374af64098e581be950f8ecea117675546d
-  data.tar.gz: 78016a17b6a3820113da61af66e62ae48efab38a752e7e4839dbde0d6e547faa77fa3cfaa529a281f8c0078c3552ef243081767daca05c982d95a04f041c8d07
+  metadata.gz: 48d7442f30326509e880a3d3076c96f4b84fb9aaede13829726f088c5617ba87a50420aec5ce851a6c177d145ed8ba4e5182f2a958ddc2664b00f2d87f1c0b43
+  data.tar.gz: 4211e6a868a560171c41d53e1b233500500370ff8432deb157db1418566e736865bd666a53a3e044b52af537bafaf17ebfe9fe341b14ade5d72953416de7c5ef

data/README.md

@@ -35,7 +35,7 @@ And if we try a nonexisting color we get an error
    expect { L43::Color.ansi_code("no_color") }.to raise_error(IndexError, "key not found: :no_color")
 ```
 
-### Context: Injecting methods into strings
+### Context: Injecting color methods into strings
 
 Given the inclusion of the string inject module
 ```ruby
@@ -47,6 +47,63 @@ Then we can make colored strings as follows
     expect("red".red).to eq("\e[31mred")
 ```
 
+### Context: Conveniently named methods
+
+Given the following
+```ruby
+   require 'l43/color/methods' 
+```
+
+Then we can get the ANSI codes as functions
+```ruby
+   expect(L43::Color::Methods.cyan).to eq("\x1b[36m") 
+```
+
+And to get rid of the long name this module can be included 
+```ruby
+    c = Class.new do
+          include L43::Color::Methods
+        end
+   expect(c.new.blue).to eq("\e[34m")
+```
+Or extended
+```ruby
+   m = Module.new do
+         extend L43::Color::Methods
+       end
+   expect(m.magenta).to eq("\e[35m")
+```
+
+### Context: Output Helpers
+
+They allow to alternate strings (to be printed verbatim) and symbols that will
+output ANSI codes
+
+Given they are included
+```ruby
+   require 'l43/color/output' 
+   include L43::Color::Output
+```
+
+Then we can use them to output to stdout
+```ruby
+   expected = "\e[31mhello\e[0mworld\n"
+   expect { putcol([:red, "hello", :reset, "world"]) }
+    .to output(expected).to_stdout_from_any_process
+
+   expect { putcol([:red, "hello", :reset, "world"], to: :stdout) }
+    .to output(expected).to_stdout_from_any_process
+```
+
+Or we can use them to output to stderr
+```ruby
+   expected = "\e[41mhello\e[4mworld\n"
+   expect { putcol([:bg_red, "hello", :ul, "world"], to: :stderr) }
+    .to output(expected).to_stderr_from_any_process
+
+   expect { putcol([:bg_red, "hello", :ul, "world"], to: $stderr) }
+    .to output(expected).to_stderr_from_any_process
+```
 ## Author
 
 Copyright © 2024 Robert Dober

data/bin/colorize

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require_relative '../lib/l43/color/cli'
+
+L43::Color::Cli.run(ARGV)
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43/color/cli.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+
+require_relative 'methods'
+module L43
+  module Color
+    module Cli extend self
+      extend Methods
+
+      def run(_args)
+        $stderr.puts [yellow, "Coming soon"].join
+      end
+      
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43/color/methods.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'definitions'
+module L43
+  module Color
+    module Methods extend self
+      Definitions::COLOR_DEFINITIONS.each do |name, code|
+        define_method(name) { code }
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43/color/output.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../color'
+module L43
+  module Color
+    module Output
+
+      def putcol(args, to: $stdout)
+        dest = _get_device(to)
+        dest.puts args.map(&_to_code).join
+      end
+      
+      private
+
+      def _get_device(desc)
+        case desc
+        when IO
+          desc
+        when :stderr
+          $stderr
+        when :stdout
+          $stdout
+        end
+      end
+
+      def _to_code
+        -> ele do
+          case ele
+          when Symbol
+            Color.ansi_code(ele)
+          else
+            ele
+          end
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43/color.rb

@@ -3,7 +3,7 @@
 require_relative 'color/definitions'
 module L43
   module Color extend self
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
 
     def ansi_code(name)
       Definitions::COLOR_DEFINITIONS.fetch(name.downcase.to_sym)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: l43_color
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert Dober
@@ -25,8 +25,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.7
 description: |
-  **PLACEHOLDER**
-  Colorize text with ANSI colors
+  Colorize text with ANSI colors.
+  Parse and render files with
+  a mini color markup language.
 email: robert.dober@gmail.com
 executables: []
 extensions: []
@@ -34,12 +35,16 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/colorize
 - lib/l43/color.rb
+- lib/l43/color/cli.rb
 - lib/l43/color/definitions.rb
+- lib/l43/color/methods.rb
+- lib/l43/color/output.rb
 - lib/l43/color/string_methods.rb
-homepage: https://gitlab.com/l43-gems/l43_color
+homepage: https://www.codeberg.org/lab419/l43_color.git
 licenses:
-- Apache-2.0
+- AGPL-3.0-or-later
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -59,5 +64,5 @@ requirements: []
 rubygems_version: 3.5.8
 signing_key:
 specification_version: 4
-summary: Colorize Text (PLACEHOLDER)
+summary: Colorize Text
 test_files: []