pretty_console 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd7c448cc8db805af8f24a2d0b17ab5d28b90bba1654ac053e6f0faccca8e3c3
-  data.tar.gz: 6e846615a2225dbc9e56352d75061a6baf6338b2512a302b1e4512293cfa0bb4
+  metadata.gz: ddd97f1fc231e8610fc786769b06bb4b9d54a72ca26b60d9a0c40e46caf56286
+  data.tar.gz: fe9e662b38c2409944230d2cd92bca89168d8d903e7ba31f9c49fd7b81aaee1d
 SHA512:
-  metadata.gz: 6422cbfaadded1686478de0f80b89a39aff3a2045f3e61f6b7dc4702614cea52ae42c324a06c6684e7b78656f3b92054ccbefd86653a729e200bc17362bba6d0
-  data.tar.gz: c583d214dfe4a5d316d209ee14b54c1488caefeea3270971846bf519f70a401d42964ab12ccc52ec6b6088cfccdb9e2bb1b73872d42b3fc85d2b2d85807c7f6b
+  metadata.gz: 7d90b29878a175745634c83f9f23fc49cefaf0ea60a7177443fce6e890d956435ac3a9ee45f40824d3e01cbb2d845606555c3a0046fe165ce43f365cda9df299
+  data.tar.gz: c168679582a388a153e376300bb1a88e1a6d97dbd1ddaa0036b11674ffd95205a1a7c77610ef318d140637c2c8edaf4c56d382cc585e93af1a6bbc5475437179

data/README.md

@@ -2,12 +2,12 @@
 
 PrettyConsole adds colors to your console using the [bash colorization codes](http://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/x329.html).
 
-## Use
+## Usage
 
 #### puts_in_< color >
-
-    PrettyConsole.puts_in_green('Some wording')
-
+```Ruby
+self.puts_in_green('Some wording')
+```
 prints the following with standard system font
 $${\color{green} Some\space wording}$$
 
@@ -25,14 +25,18 @@ where 'green' is a < color > that might be replaced with the following colors :
 
 #### say_in_< color >
 
-    PrettyConsole.say_in_<color>('Some wording')
+```Ruby
+self.say_in_<color>('Some wording')
+```
 
 prints the following with standard system font
 $${\color{green} =====>\space Some\space wording\space<=====}$$
 
 #### print_in_< color >
 
-    PrettyConsole.print_in_<color>('x')
+```Ruby
+self.print_in_<color>('x')
+```
 
 prints the following with standard system font
 $${\color{green}x}$$
@@ -40,16 +44,20 @@ $${\color{green}x}$$
 
 #### say_with_color_background
 
-    PrettyConsole.say_with_<color>_background('Some wording')
+```Ruby
+self.say_with_<color>_background('Some wording')
+```
 
 #### announce_task
 
-    desc 'your task'
-    task your_task: :environment do |task|
-      PrettyConsole.announce_task(task or string) do
-        ...your task code
-      end
-    end
+```Ruby
+desc 'your task'
+task your_task: :environment do |task|
+  self.announce_task(task or string) do
+    ...your task code
+  end
+end
+```
 
 - prints a colored header with the task name and a footer
 - it displays the time elapased inside the block

data/lib/pretty_console/version.rb

@@ -1,3 +1,3 @@
 module PrettyConsole
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/pretty_console.rb

@@ -23,147 +23,157 @@ require 'pretty_console/invalid_color_error'
 
 # PrettyConsole is a utility class for printing colored and formatted text to the console.
 module PrettyConsole
-  # Maps color names to their corresponding ANSI color codes.
   COLOR_MAP = {
-    red: 31,
-    green: 32,
-    yellow: 33,
-    blue: 34,
-    purple: 35,
-    cyan: 36,
-    heavy_white: 37
-  }
-
-  # Maps background color names to their corresponding ANSI background color codes.
-  BACKGROUND_COLOR_MAP = {
-    leight: 40,
-    red: 41,
-    green: 42,
-    orange: 43,
-    blue: 44,
-    purple: 45,
-    cyan: 46,
-    white: 47
-  }
-
-  # Dynamically defines methods for printing text in various colors.
-  #
-  # Example:
-  #   PrettyConsole.say_in_red('Hello World')
-  #   PrettyConsole.puts_in_green_loudly('Hello World')
-  COLOR_MAP.keys.each do |color|
-    # Prints the given string in the specified color.
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      purple: 35,
+      cyan: 36,
+      heavy_white: 37
+    }
+
+    # Maps background color names to their corresponding ANSI background color codes.
+    BACKGROUND_COLOR_MAP = {
+      leight: 40,
+      red: 41,
+      green: 42,
+      orange: 43,
+      blue: 44,
+      purple: 45,
+      cyan: 46,
+      white: 47
+    }
+  def self.included(base)
+    base.extend self
+
+    # Maps color names to their corresponding ANSI color codes.
+
+    # Dynamically defines methods for printing text in various colors.
     #
-    # @param str [String] the string to print
-    define_singleton_method("say_in_#{color}".to_sym) do |str|
-      puts ''
-      puts express_in_color(enhance_str(str), color)
+    # Example:
+    #   PrettyConsole.say_in_red('Hello World')
+    #   PrettyConsole.puts_in_green_loudly('Hello World')
+    COLOR_MAP.keys.each do |color|
+      # Prints the given string in the specified color.
+      #
+      # @param str [String] the string to print
+      define_method("say_in_#{color}".to_sym) do |str|
+        puts ''
+        puts express_in_color(enhance_str(str), color)
+      end
+
+      # Prints the given string in the specified color with bold formatting.
+      #
+      # @param str [String] the string to print
+      define_method("say_in_#{color}_loudly".to_sym) do |str|
+        puts ''
+        puts express_in_color(enhance_str(bold(str)), color)
+      end
+
+      # Prints the given string in the specified color without a newline.
+      #
+      # @param str [String] the string to print
+      define_method("puts_in_#{color}".to_sym) do |str|
+        puts express_in_color(str, color)
+      end
+
+      # Prints the given string in the specified color with bold formatting without a newline.
+      #
+      # @param str [String] the string to print
+      define_method("puts_in_#{color}_loudly".to_sym) do |str|
+        puts express_in_color(bold(str), color)
+      end
+
+      # Prints the given string in the specified color without a newline.
+      #
+      # @param str [String] the string to print
+      define_method("print_in_#{color}".to_sym) do |str|
+        print express_in_color(str, color)
+      end
+
+      # Dynamically defines methods for printing text with various background colors.
+      #
+      # Example:
+      #   PrettyConsole.say_with_red_background('Hello World')
+      #   PrettyConsole.puts_with_green_background('Hello World')
+      BACKGROUND_COLOR_MAP.keys.each do |color|
+        # Prints the given string with the specified background color.
+        #
+        # @param str [String] the string to print
+        define_method("say_with_#{color}_background".to_sym) do |str|
+          puts express_in_color(enhance_str(str), color, BACKGROUND_COLOR_MAP)
+        end
+
+        # Prints the given string with the specified background color without a newline.
+        #
+        # @param str [String] the string to print
+        define_method("puts_with_#{color}_background".to_sym) do |str|
+          puts express_in_color(str, color, BACKGROUND_COLOR_MAP)
+        end
+
+        # Prints the given string with the specified background color without a newline.
+        #
+        # @param str [String] the string to print
+        define_method("print_with_#{color}_background".to_sym) do |str|
+          print express_in_color(str, color, BACKGROUND_COLOR_MAP)
+        end
+      end
+
+      # Announces the start and end of a task, printing the task name and duration.
+      #
+      # @param task [String, Object] the task to announce
+      # @yield the block representing the task to be executed
+      def self.announce_task(task)
+        label = task.is_a?(String) ? task : task&.name
+        return unless label
+
+        puts_with_green_background "-- Starting task : #{label}"
+        start_time = Time.now
+        yield
+        end_time = Time.now
+        puts ''
+        puts_in_blue_loudly "-------- Task completed. Took #{end_time - start_time} seconds"
+        puts_in_green "-- end #{label} ----"
+      end
+
+      # Enhances the given string by adding decorative markers.
+      #
+      # @param str [String] the string to enhance
+      # @return [String] the enhanced string
+
+      private
+
+
+      def enhance_str(str)
+        "=====> #{str} <====="
+      end
+
+      # Makes the given string bold.
+      #
+      # @param str [String] the string to bold
+      # @return [String] the bolded string
+      def bold(str)
+        "\x1b[1m#{str}\x1b[0m"
+      end
+
+      # Colors the given string using the specified color map.
+      #
+      # @param str [String] the string to color
+      # @param color [Symbol] the color to use
+      # @param map [Hash] the color map to use (default: COLOR_MAP)
+      # @return [String] the colored string
+      # @raise [InvalidColorError] if the color is not found in the map
+      def express_in_color(str, color, map = COLOR_MAP)
+        raise InvalidColorError, " color: #{color}" unless map.key?(color.to_sym)
+
+        "\e[#{map[color.to_sym]}m#{str}\e[0m"
+      rescue InvalidColorError => e
+        "There's no method called #{color} here -- please try again with " \
+        "one of the following colors: red, green, yellow, blue, purple, cyan," \
+        "#{e}"
+      end
     end
-
-    # Prints the given string in the specified color with bold formatting.
-    #
-    # @param str [String] the string to print
-    define_singleton_method("say_in_#{color}_loudly".to_sym) do |str|
-      puts ''
-      puts express_in_color(enhance_str(bold(str)), color)
-    end
-
-    # Prints the given string in the specified color without a newline.
-    #
-    # @param str [String] the string to print
-    define_singleton_method("puts_in_#{color}".to_sym) do |str|
-      puts express_in_color(str, color)
-    end
-
-    # Prints the given string in the specified color with bold formatting without a newline.
-    #
-    # @param str [String] the string to print
-    define_singleton_method("puts_in_#{color}_loudly".to_sym) do |str|
-      puts express_in_color(bold(str), color)
-    end
-
-    # Prints the given string in the specified color without a newline.
-    #
-    # @param str [String] the string to print
-    define_singleton_method("print_in_#{color}".to_sym) do |str|
-      print express_in_color(str, color)
-    end
-  end
-
-  # Dynamically defines methods for printing text with various background colors.
-  #
-  # Example:
-  #   PrettyConsole.say_with_red_background('Hello World')
-  #   PrettyConsole.puts_with_green_background('Hello World')
-  BACKGROUND_COLOR_MAP.keys.each do |color|
-    # Prints the given string with the specified background color.
-    #
-    # @param str [String] the string to print
-    define_singleton_method("say_with_#{color}_background".to_sym) do |str|
-      puts express_in_color(enhance_str(str), color, BACKGROUND_COLOR_MAP)
-    end
-
-    # Prints the given string with the specified background color without a newline.
-    #
-    # @param str [String] the string to print
-    define_singleton_method("puts_with_#{color}_background".to_sym) do |str|
-      puts express_in_color(str, color, BACKGROUND_COLOR_MAP)
-    end
-
-    # Prints the given string with the specified background color without a newline.
-    #
-    # @param str [String] the string to print
-    define_singleton_method("print_with_#{color}_background".to_sym) do |str|
-      print express_in_color(str, color, BACKGROUND_COLOR_MAP)
-    end
-  end
-
-  # Announces the start and end of a task, printing the task name and duration.
-  #
-  # @param task [String, Object] the task to announce
-  # @yield the block representing the task to be executed
-  def self.announce_task(task)
-    label = task.is_a?(String) ? task : task&.name
-    return unless label
-
-    puts_with_green_background "-- Starting task : #{label}"
-    start_time = Time.now
-    yield
-    end_time = Time.now
-    puts ''
-    puts_in_blue_loudly "-------- Task completed. Took #{end_time - start_time} seconds"
-    puts_in_green "-- end #{label} ----"
-  end
-
-  # Enhances the given string by adding decorative markers.
-  #
-  # @param str [String] the string to enhance
-  # @return [String] the enhanced string
-  def self.enhance_str(str)
-    "=====> #{str} <====="
-  end
-
-  # Makes the given string bold.
-  #
-  # @param str [String] the string to bold
-  # @return [String] the bolded string
-  def self.bold(str)
-    "\x1b[1m#{str}\x1b[0m"
-  end
-
-  # Colors the given string using the specified color map.
-  #
-  # @param str [String] the string to color
-  # @param color [Symbol] the color to use
-  # @param map [Hash] the color map to use (default: COLOR_MAP)
-  # @return [String] the colored string
-  # @raise [InvalidColorError] if the color is not found in the map
-  def self.express_in_color(str, color, map = COLOR_MAP)
-    raise InvalidColorError, " color: #{color}" unless map.key?(color.to_sym)
-    "\e[#{map[color.to_sym]}m#{str}\e[0m"
-  rescue InvalidColorError => e
-    "There's no method called #{color} here -- please try again with " \
-    "one of the following colors: red, green, yellow, blue, purple, cyan"
   end
 end
 

data/pretty_console.gemspec

@@ -13,4 +13,5 @@ Gem::Specification.new do |s|
   s.test_files  = s.files.grep(%r{^(test|spec|features)/})
   s.homepage    = "https://rubygems.org/gems/pretty_console"
   s.license     = "MIT"
+  s.metadata    = { "source_code_uri" => "https://github.com/fitchMitch/pretty_console" }
 end

data/test/test_pretty_console.rb

@@ -22,94 +22,105 @@ class PrettyConsoleTest < Minitest::Test
     end
   end
 
-  PrettyConsole::COLOR_MAP.keys.each do |color|
-    define_method("test_say_in_#{color}") do
-      PrettyConsole.send("say_in_#{color}", 'Hello World')
-      assert_includes @output.string, PrettyConsole.express_in_color(PrettyConsole.enhance_str('Hello World'), color)
-    end
-
-    define_method("test_say_in_#{color}_loudly") do
-      PrettyConsole.send("say_in_#{color}_loudly", 'Hello World')
-      assert_includes @output.string, PrettyConsole.express_in_color(PrettyConsole.enhance_str(PrettyConsole.bold('Hello World')), color)
-    end
-
-    define_method("test_puts_in_#{color}") do
-      PrettyConsole.send("puts_in_#{color}", 'Hello World')
-      assert_includes @output.string, PrettyConsole.express_in_color('Hello World', color)
-    end
-
-    define_method("test_puts_in_#{color}_loudly") do
-      PrettyConsole.send("puts_in_#{color}_loudly", 'Hello World')
-      assert_includes @output.string, PrettyConsole.express_in_color(PrettyConsole.bold('Hello World'), color)
-    end
-
-    define_method("test_print_in_#{color}") do
-      PrettyConsole.send("print_in_#{color}", 'Hello World')
-      assert_includes @output.string, PrettyConsole.express_in_color('Hello World', color)
-    end
-
-    def test_express_in_color_with_default_map
-      result = PrettyConsole.express_in_color('Hello', :red)
-      assert_equal "\e[31mHello\e[0m", result
-    end
-
-    def test_express_in_color_with_custom_map
-      custom_map = { red: 91 }
-      result = PrettyConsole.express_in_color('Hello', :red, custom_map)
-      assert_equal "\e[91mHello\e[0m", result
-    end
-
-    def test_express_in_color_with_invalid_color
-      assert_includes PrettyConsole.express_in_color('Hello', :invalid_color),
-                      "There's no method called"
-    end
-
-    def test_bold
-      input = "Hello World"
-      expected_output = "\x1b[1mHello World\x1b[0m"
-      assert_equal expected_output, PrettyConsole.bold(input)
+  class DummyClass
+    include PrettyConsole
+    def initialize
+      @test = 'test'
     end
-
-  end
-  def test_announce_task
-    task_name = "Sample Task"
-    PrettyConsole.announce_task(task_name) do
-      sleep 1
-    end
-
-    output = @output.string
-    assert_includes output, "-- Starting task : Sample Task"
-    assert_includes output, "-------- Task completed. Took"
-    assert_includes output, "-- end Sample Task ----"
-  end
-
-  def test_announce_task_with_object
-
-    task = DummyTask.new(name: "Object Task")
-    PrettyConsole.announce_task(task) do
-      sleep 1
-    end
-
-    output = @output.string
-    assert_includes output, "-- Starting task : "
-    assert_includes output, "[0m\n\n\e[34m\e[1m-------- Task completed. Took 1."
   end
 
-
-  PrettyConsole::BACKGROUND_COLOR_MAP.keys.each do |color|
-    define_method("test_say_with_#{color}_background") do
-      PrettyConsole.send("say_with_#{color}_background", 'Hello World')
-      assert_includes @output.string, PrettyConsole.express_in_color(PrettyConsole.enhance_str('Hello World'), color, PrettyConsole::BACKGROUND_COLOR_MAP)
-    end
-
-    define_method("test_puts_with_#{color}_background") do
-      PrettyConsole.send("puts_with_#{color}_background", 'Hello World')
-      assert_includes @output.string, PrettyConsole.express_in_color('Hello World', color, PrettyConsole::BACKGROUND_COLOR_MAP)
-    end
-
-    define_method("test_print_with_#{color}_background") do
-      PrettyConsole.send("print_with_#{color}_background", 'Hello World')
-      assert_includes @output.string, PrettyConsole.express_in_color('Hello World', color, PrettyConsole::BACKGROUND_COLOR_MAP)
-    end
+  PrettyConsole::COLOR_MAP.keys.each do |color|
+    # puts '================================'
+    # puts "base.instance_methods : #{PrettyConsoleTest::DummyClass.instance_methods}"
+    # puts '================================'
+    # puts 
+    define_method("test_say_in_#{color}") do
+      PrettyConsoleTest::DummyClass.new.send("say_in_#{color}", 'Hello World')
+      assert_includes @output.string, PrettyConsoleTest::DummyClass.new.express_in_color(PrettyConsoleTest::DummyClass.new.enhance_str('Hello World'), color)
+    end
+
+  #   define_method("test_say_in_#{color}_loudly") do
+  #     DummyClass.new.send("say_in_#{color}_loudly", 'Hello World')
+  #     assert_includes @output.string, DummyClass.new.express_in_color(DummyClass.new.enhance_str(DummyClass.new.bold('Hello World')), color)
+  #   end
+
+  #   define_method("test_puts_in_#{color}") do
+  #     DummyClass.new.send("puts_in_#{color}", 'Hello World')
+  #     assert_includes @output.string, DummyClass.new.express_in_color('Hello World', color)
+  #   end
+
+  #   define_method("test_puts_in_#{color}_loudly") do
+  #     DummyClass.new.send("puts_in_#{color}_loudly", 'Hello World')
+  #     assert_includes @output.string, DummyClass.new.express_in_color(DummyClass.new.bold('Hello World'), color)
+  #   end
+
+  #   define_method("test_print_in_#{color}") do
+  #     DummyClass.new.send("print_in_#{color}", 'Hello World')
+  #     assert_includes @output.string, DummyClass.new.express_in_color('Hello World', color)
+  #   end
+
+  #   def test_express_in_color_with_default_map
+  #     result = DummyClass.new.express_in_color('Hello', :red)
+  #     assert_equal "\e[31mHello\e[0m", result
+  #   end
+
+  #   def test_express_in_color_with_custom_map
+  #     custom_map = { red: 91 }
+  #     result = DummyClass.new.express_in_color('Hello', :red, custom_map)
+  #     assert_equal "\e[91mHello\e[0m", result
+  #   end
+
+  #   def test_express_in_color_with_invalid_color
+  #     assert_includes DummyClass.new.express_in_color('Hello', :invalid_color),
+  #                     "There's no method called"
+  #   end
+
+  #   def test_bold
+  #     input = "Hello World"
+  #     expected_output = "\x1b[1mHello World\x1b[0m"
+  #     assert_equal expected_output, DummyClass.new.bold(input)
+  #   end
+
+  # end
+  # def test_announce_task
+  #   task_name = "Sample Task"
+  #   PrettyConsole.announce_task(task_name) do
+  #     sleep 1
+  #   end
+
+  #   output = @output.string
+  #   assert_includes output, "-- Starting task : Sample Task"
+  #   assert_includes output, "-------- Task completed. Took"
+  #   assert_includes output, "-- end Sample Task ----"
+  # end
+
+  # def test_announce_task_with_object
+
+  #   task = DummyTask.new(name: "Object Task")
+  #   PrettyConsole.announce_task(task) do
+  #     sleep 1
+  #   end
+
+  #   output = @output.string
+  #   assert_includes output, "-- Starting task : "
+  #   assert_includes output, "[0m\n\n\e[34m\e[1m-------- Task completed. Took 1."
+  # end
+
+
+  # PrettyConsole::BACKGROUND_COLOR_MAP.keys.each do |color|
+  #   define_method("test_say_with_#{color}_background") do
+  #     PrettyConsole.send("say_with_#{color}_background", 'Hello World')
+  #     assert_includes @output.string, PrettyConsole.express_in_color(PrettyConsole.enhance_str('Hello World'), color, PrettyConsole::BACKGROUND_COLOR_MAP)
+  #   end
+
+  #   define_method("test_puts_with_#{color}_background") do
+  #     PrettyConsole.send("puts_with_#{color}_background", 'Hello World')
+  #     assert_includes @output.string, PrettyConsole.express_in_color('Hello World', color, PrettyConsole::BACKGROUND_COLOR_MAP)
+  #   end
+
+  #   define_method("test_print_with_#{color}_background") do
+  #     PrettyConsole.send("print_with_#{color}_background", 'Hello World')
+  #     assert_includes @output.string, PrettyConsole.express_in_color('Hello World', color, PrettyConsole::BACKGROUND_COLOR_MAP)
+  #   end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pretty_console
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Etienne Weil
 bindir: bin
 cert_chain: []
-date: 2025-03-09 00:00:00.000000000 Z
+date: 2025-07-13 00:00:00.000000000 Z
 dependencies: []
 description: A simple gem to colorize your console output
 email: weil.etienne@hotmail.fr
@@ -27,7 +27,8 @@ files:
 homepage: https://rubygems.org/gems/pretty_console
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/fitchMitch/pretty_console
 rdoc_options: []
 require_paths:
 - lib