pretty_console 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c8f384cc0171d47d47c79ffbee696731b64c45754e57acb24a17516a5b73e5d
-  data.tar.gz: 42143c7c49e749ee581d64a23378751ced816b16defb3ede8bf55486996d8cee
+  metadata.gz: bd7c448cc8db805af8f24a2d0b17ab5d28b90bba1654ac053e6f0faccca8e3c3
+  data.tar.gz: 6e846615a2225dbc9e56352d75061a6baf6338b2512a302b1e4512293cfa0bb4
 SHA512:
-  metadata.gz: 7216a6d220124b6cf62a4e4c56a46e2dcbf8ff81b86f0f8e63e604299de8603eef19db9bbc83515d39e2883a67c2ba6db1795463874d9d1b9a0f4fc649e7dd31
-  data.tar.gz: b6f3bd0d68721f3a725f6a081e33c7203a60f5b769b662f05bb7e3c43344ad5dc62ae555ebe272cbc6e7ae4c2e1cf9495d377bdcda5a851d58085f821f4c5266
+  metadata.gz: 6422cbfaadded1686478de0f80b89a39aff3a2045f3e61f6b7dc4702614cea52ae42c324a06c6684e7b78656f3b92054ccbefd86653a729e200bc17362bba6d0
+  data.tar.gz: c583d214dfe4a5d316d209ee14b54c1488caefeea3270971846bf519f70a401d42964ab12ccc52ec6b6088cfccdb9e2bb1b73872d42b3fc85d2b2d85807c7f6b

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.rbc

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joey Aghion
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# PrettyConsole
+
+PrettyConsole adds colors to your console using the [bash colorization codes](http://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/x329.html).
+
+## Use
+
+#### puts_in_< color >
+
+    PrettyConsole.puts_in_green('Some wording')
+
+prints the following with standard system font
+$${\color{green} Some\space wording}$$
+
+
+##### Colors
+where 'green' is a < color > that might be replaced with the following colors :
+- red,
+- green (as used)
+- yellow
+- blue
+- purple
+- cyan
+- heavy_white
+- and green
+
+#### say_in_< color >
+
+    PrettyConsole.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')
+
+prints the following with standard system font
+$${\color{green}x}$$
+
+
+#### say_with_color_background
+
+    PrettyConsole.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
+
+- prints a colored header with the task name and a footer
+- it displays the time elapased inside the block
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pretty_console'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pretty_console
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+&copy; Etienne Weil
+
+[LICENSE](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+end
+
+desc "Run tests"
+task default: :test

data/lib/pretty_console/version.rb

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

data/pretty_console.gemspec

@@ -0,0 +1,16 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pretty_console/version'
+
+Gem::Specification.new do |s|
+  s.name        = "pretty_console"
+  s.version     = PrettyConsole::VERSION
+  s.description = "A simple gem to colorize your console output"
+  s.summary     = s.description
+  s.authors     = ["Etienne Weil"]
+  s.email       = "weil.etienne@hotmail.fr"
+  s.files       = `git ls-files`.split($/)
+  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
+  s.homepage    = "https://rubygems.org/gems/pretty_console"
+  s.license     = "MIT"
+end

data/test/test_pretty_console.rb

@@ -0,0 +1,115 @@
+require 'minitest/autorun'
+require 'pretty_console'
+
+class PrettyConsoleTest < Minitest::Test
+  def setup
+    @output = StringIO.new
+    @original_stdout = $stdout
+    $stdout = @output
+  end
+
+  def teardown
+    $stdout = @original_stdout
+  end
+
+  class DummyTask
+    def name
+      @name
+    end
+
+    def initialize(name)
+      @name = name
+    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)
+    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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pretty_console
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Etienne Weil
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-08 00:00:00.000000000 Z
+date: 2025-03-09 00:00:00.000000000 Z
 dependencies: []
 description: A simple gem to colorize your console output
 email: weil.etienne@hotmail.fr
@@ -16,13 +15,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- LICENCE.txt
+- README.md
+- Rakefile
 - lib/pretty_console.rb
 - lib/pretty_console/invalid_color_error.rb
+- lib/pretty_console/version.rb
+- pretty_console.gemspec
+- test/test_pretty_console.rb
 homepage: https://rubygems.org/gems/pretty_console
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -37,8 +42,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
-summary: pretty_console summary
-test_files: []
+summary: A simple gem to colorize your console output
+test_files:
+- test/test_pretty_console.rb