kolorit 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef040c50bebe6a3d79fcaee8de83f9bd97233b9e432d6a232db7137beff88643
-  data.tar.gz: c262eabd58497efbfa76e72d918c1b2a6445c2a7dec772a0cbd67c97722d5b86
+  metadata.gz: 219b95536dadf60c775fc7346daf11c5e5d2150bc634f9effb2c2008b6b83fd6
+  data.tar.gz: bd0c07c902a020d41f8df17952b6df00330954ffce38809a2b34faec46cf7c47
 SHA512:
-  metadata.gz: 0dac1ce53413bc676b2d03a0d3be3b8b27129ab02f2137dca9112e9ded142d184c320912b7560fd59b377564d3edcf95131ae3b6e372e6b001a3f2b493d45806
-  data.tar.gz: 63cd157d5400ac32f2eeca5e0b7af678175f5f3e94dc464175b8269ed1ecde08d9632ec52e5023e89e2096005dad35b05c6a62a92baf2d2455445595d5758443
+  metadata.gz: 5842b9370bedb89d2daf73ef8018f144271cd3851a164a8157dcc3388541b9773312c24782a113670d9a2b6ec1cd88f14d82b4cb25197dda0b46c77dbf50b914
+  data.tar.gz: fbda9da5af368ec58ee28bd1bb6927d93655f793c3f184eafb6123b19e8d0e62b320fc4fce7617f2bc9e9803720963d36346e9262d8b902bbc3cce8f2e022836

data/lib/kolorit/linux.rb

@@ -1,51 +1,37 @@
 # frozen_string_literal: true
 
 module Kolorit
+  ##
+  # Color codes for linux systems.
+  # Allow use of color methods when included in **String** class.
+  # @see Kolorit
+  #
   module Linux
-    def black = colorize(30)
-
-    def red = colorize(31)
-
-    def green = colorize(32)
-
-    def yellow = colorize(33)
-
-    def blue = colorize(34)
-
-    def pink = colorize(35)
-
-    def cyan = colorize(36)
-
-    def gray = colorize(37)
-
-    def bold = colorize(1)
-
-    def italic = colorize(3)
-
-    def underline = colorize(4)
-
-    def blink = colorize(5)
-
+    def red     = colorize(31)
+    def green   = colorize(32)
+    def yellow  = colorize(33)
+    def blue    = colorize(34)
+    def pink    = colorize(35)
+    def cyan    = colorize(36)
+    def gray    = colorize(37)
+
+    def bold          = colorize(1)
+    def italic        = colorize(3)
+    def underline     = colorize(4)
+    def blink         = colorize(5)
     def reverse_color = colorize(7)
 
     private
 
-    ##
-    # colorize string based on color_code
-    #
     def colorize(color_code)
-      # check if we change color or type
       type = case color_code
-             # for type-change
              when 1 then 22 # bold
              when 3 then 23 # italic
              when 4 then 24 # underline
              when 5 then 25 # blink
              when 7 then 27 # reverse_color
-             # for color change
              else 0
              end
-      # create colorized string
       "\e[#{color_code}m#{self}\e[#{type}m"
     end
   end

data/lib/kolorit/version.rb

@@ -2,5 +2,5 @@
 
 module Kolorit
   # gem version
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/kolorit.rb

@@ -2,18 +2,31 @@
 
 require_relative 'kolorit/version'
 
+##
+# Handle modules with color codes and methods to colorize string.
+# Right module is included depending on user OS.
+#
+# @example Colorize string
+#  'I am mr Red String'.red
+#  'I am mr Green String'.green
+#  'I am bold (fat) mis Pink String'.pink.bold
+#
+# @example Available colors
+#  red, green, yellow, blue, pink, cyan, gray
+#
+# @example Available types
+#  bold, italic, underline, blink, reverse_color
+#
 module Kolorit
 end
 
+klass = String
+
 if ENV['OS'] == 'Windows_NT'
+  # working on windows color codes
   # require_relative 'kolorit/windows'
-  class String
-    # working on windows color codes
-    # include Kolorit::Windows unless RUBY_PLATFORM =~ /cygwin/
-  end
+  # klass.include Kolorit::Windows unless RUBY_PLATFORM =~ /cygwin/
 else
   require_relative 'kolorit/linux'
-  class String
-    include Kolorit::Linux
-  end
+  klass.include(Kolorit::Linux)
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: kolorit
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies: []
 description: |
   Print your terminal output in different colors. Early development stage,
-  for now only Linux and Mac. MIT license.'
+  for now only Linux and Mac. MIT license.
 email:
 - alx3dev@gmail.com
 executables: []
@@ -30,7 +30,8 @@ metadata:
   homepage_uri: https://www.github.com/alx3dev/kolorit
   source_code_uri: https://www.github.com/alx3dev/kolorit
   changelog_uri: https://www.github.com/alx3dev/kolorit/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/kolorit
+  documentation_uri: https://rubydoc.info/gems/kolorit/0.1.4
+  license_uri: https://www.github.com/alx3dev/kolorit/LICENSE
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -49,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Colorize terminal output. Linux-Mac only, Windows CLI coming soon.