kolorit 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219b95536dadf60c775fc7346daf11c5e5d2150bc634f9effb2c2008b6b83fd6
-  data.tar.gz: bd0c07c902a020d41f8df17952b6df00330954ffce38809a2b34faec46cf7c47
+  metadata.gz: fdbfa5dc4a917af5db6c5af7d92c29784754f17afe28e28b9e9b2183bc30812d
+  data.tar.gz: 9c0c4f30ec7147f8b0ef26a794aca493a58eb150a050bb9f9004480efdb4bd0d
 SHA512:
-  metadata.gz: 5842b9370bedb89d2daf73ef8018f144271cd3851a164a8157dcc3388541b9773312c24782a113670d9a2b6ec1cd88f14d82b4cb25197dda0b46c77dbf50b914
-  data.tar.gz: fbda9da5af368ec58ee28bd1bb6927d93655f793c3f184eafb6123b19e8d0e62b320fc4fce7617f2bc9e9803720963d36346e9262d8b902bbc3cce8f2e022836
+  metadata.gz: 312362814ac515dd8ab83a13531ea3fbbae6abade783a78f640b288869c9e0cdf0d36c1b9be8607328835373a1cb63d95f77081ac2c23fdf9c5c5ec8eff202f7
+  data.tar.gz: 58e3143322813034aee0ebc4fc57d8edf29fa5048fecec0005898aa26b2b5c0661b55d827ca1b4785ee103ea852ca49ebdff88a6c776865c31352b038dfa30cc

data/lib/kolorit/linux.rb

@@ -2,37 +2,95 @@
 
 module Kolorit
   ##
-  # Color codes for linux systems.
-  # Allow use of color methods when included in **String** class.
+  # kolor codes for linux systems.
+  # Allow use of kolor methods when included in class.
   # @see Kolorit
+  # @see https://www.github.com/alx3dev/kolorit/README.md
+  #
+  # @todo Use `def red = kolor(int)` in ruby > 3.0
   #
   module Linux
-    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)
+    def red
+      kolor(31)
+    end
+
+    def green
+      kolor(32)
+    end
+
+    def yellow
+      kolor(33)
+    end
+
+    def blue
+      kolor(34)
+    end
+
+    def pink
+      kolor(35)
+    end
+
+    def cyan
+      kolor(36)
+    end
+
+    def gray
+      kolor(37)
+    end
+
+    def bold
+      kolor(1)
+    end
+
+    def italic
+      kolor(3)
+    end
+
+    def underline
+      kolor(4)
+    end
+
+    def blink
+      kolor(5)
+    end
+
+    def reverse_color
+      kolor(7)
+    end
+    alias inverse reverse_color
+
+    # @depreceated Use direct color methods insted #red, #blue ...
+    # this is part of code that make rubocop sad
+    def colorize(clr)
+      case clr.to_sym
+      when :red then red
+      when :green then green
+      when :yellow then yellow
+      when :blue then blue
+      when :pink then pink
+      when :cyan then cyan
+      when :gray then gray
+      when :bold then bold
+      when :italic then italic
+      when :underline then underline
+      when :blink then blink
+      when :reverse_color, :inverse then reverse_color
+      else self
+      end
+    end
 
     private
 
-    def colorize(color_code)
-      type = case color_code
-             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
-             else 0
-             end
-      "\e[#{color_code}m#{self}\e[#{type}m"
+    def kolor(color_code)
+      style = case color_code
+              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_kolor
+              else 0
+              end
+      "\e[#{color_code}m#{self}\e[#{style}m"
     end
   end
 end

data/lib/kolorit/version.rb

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

data/lib/kolorit.rb

@@ -6,6 +6,13 @@ require_relative 'kolorit/version'
 # Handle modules with color codes and methods to colorize string.
 # Right module is included depending on user OS.
 #
+# @example (opt 1) - Require everything and override String class
+#  require 'kolorit' => include color methods in class String
+#
+# @example (opt 2) - Require what you need, include where you need it
+#  require 'kolorit/linux' => just require, no override
+#  include Kolorit::Linux => use color methods in your class
+#
 # @example Colorize string
 #  'I am mr Red String'.red
 #  'I am mr Green String'.green
@@ -14,19 +21,43 @@ require_relative 'kolorit/version'
 # @example Available colors
 #  red, green, yellow, blue, pink, cyan, gray
 #
-# @example Available types
+# @example Available styles
 #  bold, italic, underline, blink, reverse_color
 #
 module Kolorit
+  class << self
+    def env_os_win?
+      ENV['OS'] == 'Windows_NT'
+    end
+
+    def on_windows?
+      if env_os_win?
+        return false if RUBY_PLATFORM =~ /cygwin/
+
+        true
+      else
+        false
+      end
+    end
+    alias windows? on_windows?
+  end
 end
 
+raise(StandardError, 'Windows not supported, yet!', []) if Kolorit.on_windows?
+
 klass = String
 
-if ENV['OS'] == 'Windows_NT'
-  # working on windows color codes
-  # require_relative 'kolorit/windows'
-  # klass.include Kolorit::Windows unless RUBY_PLATFORM =~ /cygwin/
-else
-  require_relative 'kolorit/linux'
-  klass.include(Kolorit::Linux)
+if Kolorit.windows? && !defined?(Kolorit::Windows)
+  require_relative 'kolorit/windows'
+  klass.include Kolorit::Windows
+
+elsif !defined?(Kolorit::Linux)
+  begin
+    require 'win32console' if Kolorit.env_os_win?
+  rescue StandardError
+    raise StandardError 'please run: $ gem install win32console.'
+  ensure
+    require_relative 'kolorit/linux'
+    klass.include(Kolorit::Linux)
+  end
 end

metadata

@@ -1,18 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: kolorit
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-01-30 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.
+  Print your terminal output in different colors. Now compatible with Ruby version 2,
+  not only 3. Linux and Mac, Windows should work with `win32console` but not tested.
+  Early development stage, MIT license.
 email:
 - alx3dev@gmail.com
 executables: []
@@ -30,7 +31,7 @@ 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/0.1.4
+  documentation_uri: https://rubydoc.info/gems/kolorit/0.1.5
   license_uri: https://www.github.com/alx3dev/kolorit/LICENSE
 post_install_message:
 rdoc_options: []
@@ -43,7 +44,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: 4.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="