kolorit 0.2.0.pre.dev → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5e2ca034fd3bfb8d36f988cc12e9014fea4ae1aae98a21f5312e1752b53931e
-  data.tar.gz: a317b400ccd1adf91302ec9a451a6ef9b6cb5878ba6e7589f18d64c98e742cb3
+  metadata.gz: bb708f14550d48ef0bc7715e54948c60310eae2b1b630c664727edec7ffd5a20
+  data.tar.gz: b03cb0001044f58e519b414235b49e9e6574e7af3c55f4a26dd2d67b8c768205
 SHA512:
-  metadata.gz: c727a260c985a1b711c2caf3f8fc289034ab9b921c75db344ff531f7aec94af5d693dda8c9c9d60bedca754fe0336671e43f208ef0adac70828c91e79eea9621
-  data.tar.gz: f04a0ab07f3eeae402faa39d3b58b44a14e9e95c1aed2319500fdc90da15ed5131deb99677d7387642b29ec037799b5eb9f24a9fc04f86eda51109e98adf2b90
+  metadata.gz: 7abc3838e802e519a0c1657ba29994abefb11aa331a9d147ffbea2529437e33ee9abb9f51f2be6ece8a6eed9d8dff691257504a7f733e28065ae0a52c64c05dd
+  data.tar.gz: e25dd52f426f1107cee3755d63001a7842692673e18f3342d18d5af342493be42f5ca0e24891d933338a0730b74b2625f25a5838a4c8a4332de5e03bd3f0b7b3

data/README.md

@@ -5,12 +5,10 @@
 Still in early development stage, meaning windows support should come in near future.
 For now, windows 10 users should be able to use it with `win32console` gem, but it's not tested yet.
 
-Gem work with `Ruby 2.6 >`. It's almost compatible with `colorize` gem, but some colors are not implemented yet
-_(light blue, light green ...)_, and background colors.
+Kolorit allow you to easily colorize any string, integer, array, hash, without touching core classes.
+Use methods `#colorize` and `#kolorize` for power of Ruby blocks.
 
-You should call `String#red` not `String#colorize(:red)`, it takes more resources.
-#### TO-DO: documentation
-[some badly written docs](https://rubydoc.info/gems/kolorit/0.1.5)
+# How to install
 
 GitHub repo is always updated before rubygems.
 ```bash
@@ -24,23 +22,24 @@ Install from rubygems:
 gem install kolorit
 ```
 
-Usage:
+# How to use:
 
  - Include kolorit methods, allow use on string, integer, array, hash
 
 ```ruby
-require 'kolorit'
+# you can call method on string only if you include module outside of main namespace.
+# that's what happen when you require kolorit
 
+require 'kolorit'
 'this is red string'.red
 
-'this is bold cyan string'.bold.cyan
-
-colorize :blue, 'params'
 ```
 
  - Inlcude kolorit module to be used where you need it
 
 ```ruby
+# if you include it inside another class/module, call methods with arguments
+
 require 'kolorit/linux' # or 'kolorit/windows'
 
 include Kolorit::Linux # or ::Windows
@@ -49,37 +48,11 @@ blue 'some string'
 red 'red bold string'
 ```
 
-`#colorize` accept color as argument, and string as second  
-`#kolorize` accept string as argument and color as second
-
-Both of this methods also accept block - Colorize block should return `:color`,
-while `#kolorize` block should return string to be colored.
-
-```ruby
-colorize(:red) do
-  if some_variable > 10
-    puts 'more then 10'
-  else
-    puts 'less then 10'.bold
-  end
-end
-
-@var = true
-colorize(:bold) { @var.is_a?(TrueClass) ? :green : :red }
-```
-
-```ruby
-kolorize('some_variable') do
-  if some_variable > 10
-    :green
-  else
-    :red
-  end
-end
+`#colorize` accept color as first argument, and string as second  
+`#kolorize` accept string as first argument and color as second
 
-@var = 'SUCCESS!'
-kolorize(@var) { @var.nil? ? :red : :green }
-```
+Both of this methods also accept block - `#colorize` block should return `:color`,
+while `#kolorize` block should return `'string'` to be colorized.
 
 You can allow methods to automatically `#puts` or `#print` colorized string:
 
@@ -100,3 +73,58 @@ Kolorit.disable
 # or
 Kolorit.enable
 ```
+
+ > Examples are better then documentation, so until I write docs...
+
+**[example 1]**
+```ruby
+colorize(:green) do
+  if RUBY_VERSION.start_with?('3')
+    'Happy Coding!'.bold
+  else
+    'You should try Ruby 3, it is much better!'
+  end
+end
+```
+
+**[example 2]**
+```ruby
+def color_line(param)
+
+  # check if kolorit is enabled (default: true)
+  status = Kolorit.enabled?
+
+  # enable kolorit if disabled
+  Kolorit.enable
+
+  # colorize param based on it's class
+  colorize(:cyan) do
+    case param.class.name
+    when 'String'
+      :green
+    when 'Integer'
+      :yellow
+    else
+      :gray
+    end
+  end
+
+  # keep module status same as before method action
+  Kolorit.disable unless status
+end
+```
+
+**[example 3]**
+```ruby
+# enable automated #puts or #print
+Kolorit.output :puts
+
+# define message to print
+message = 'Thank you Matz, for Amazing Ruby '
+
+# print bold cyan message based on block evaluation
+colorize(:bold) { RUBY_VERSION[0] == '3' ? message + '3' : message + 'language'}.cyan
+
+# disable output
+Kolorit.output false
+```

data/lib/kolorit/linux.rb

@@ -54,29 +54,65 @@ module Kolorit
   # @see https://www.github.com/alx3dev/kolorit/README.md
   #
   module Linux
-    def red(str = nil);    kolor(31, str) end
-    def green(str = nil);  kolor(32, str) end
-    def yellow(str = nil); kolor(33, str) end
-    def blue(str = nil);   kolor(34, str) end
-    def pink(str = nil);   kolor(35, str) end
-    def cyan(str = nil);   kolor(36, str) end
-    def gray(str = nil);   kolor(37, str) end
-
-    def bold(str = nil);           kolor(1, str) end
-    def italic(str = nil);         kolor(3, str) end
-    def underline(str = nil);      kolor(4, str) end
-    def blink(str = nil);          kolor(5, str) end
-    def reverse_color(str = nil);  kolor(7, str) end
+    def red(str = nil)
+      kolor(31, str)
+    end
+
+    def green(str = nil)
+      kolor(32, str)
+    end
+
+    def yellow(str = nil)
+      kolor(33, str)
+    end
+
+    def blue(str = nil)
+      kolor(34, str)
+    end
+
+    def pink(str = nil)
+      kolor(35, str)
+    end
+
+    def cyan(str = nil)
+      kolor(36, str)
+    end
+
+    def gray(str = nil)
+      kolor(37, str)
+    end
+
+    def bold(str = nil)
+      kolor(1, str)
+    end
+
+    def italic(str = nil)
+      kolor(3, str)
+    end
+
+    def underline(str = nil)
+      kolor(4, str)
+    end
+
+    def blink(str = nil)
+      kolor(5, str)
+    end
+
+    def reverse_color(str = nil)
+      kolor(7, str)
+    end
 
     alias inverse reverse_color
 
     def colorize(color, string = nil, &blk)
       string = yield(blk) if block_given?
+      color = KOLORS[color.to_sym] unless color.is_a?(Integer)
       kolor color, string
     end
 
     def kolorize(string, color = nil, &blk)
-      color = block_given? ? yield(blk) : :cyan
+      color = yield(blk) if block_given?
+      color = KOLORS[color.to_sym] unless color.is_a?(Integer)
       kolor color, string
     end
 
@@ -84,31 +120,34 @@ module Kolorit
 
     def kolor(color, param = nil)
       param = self if param.nil?
-      return param unless Kolorit.enabled?
-
-      color = Kolors[color.to_sym] unless color.is_a?(Integer)
-      style =
-        case color
-          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
-
-      string = "\e[#{color}m#{param}\e[#{style}m"
-      case Kolorit.output?
+      string = color_style color, param
+      unless (1..7).include? color
+        case Kolorit.output?
         when :puts  then puts string
         when :print then print string
-      end unless (1..7).include? color
+        end
+      end
       string
     end
+
+    def color_style(color, param)
+      return param unless Kolorit.enabled?
+
+      style = case color
+              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}m#{param}\e[#{style}m"
+    end
   end
   ##
   # Lookup for color-code by name.
   #
-  Kolors = { red: 31, green: 32, yellow: 33,
+  KOLORS = { red: 31, green: 32, yellow: 33,
              blue: 34, pink: 35, cyan: 36,
              gray: 37, bold: 1, italic: 3,
              underline: 4, blink: 5, inverse: 7 }.freeze

data/lib/kolorit/version.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
+#
+# Check if we need **win32console** gem.
+# Defined here because we need it in _.gemspec_ file.
+#
+# Check either to puts/print or just return colorized string
+# Disable/Enable globally
+#
 module Kolorit
   # gem version
-  VERSION = '0.2.0-dev'
-
-  ##
-  # Check if we need **win32console** gem.
-  # Defined here because we need it in _.gemspec_ file.
-  #
-  # Check either to puts/print or just return colorized string
-  #
+  VERSION = '0.2.0'
+
   class << self
     def win_32_console?
       win? && cygwin?
@@ -27,13 +28,13 @@ module Kolorit
       @enable != false
     end
 
-    def enable(param = true)
-      @enable = param.is_a? TrueClass
+    def enable(color: true)
+      @enable = color.is_a? TrueClass
     end
     alias enable= enable
 
     def disable
-      enable false
+      enable color: false
     end
 
     def output?

data/lib/kolorit/windows.rb

@@ -3,12 +3,17 @@
 require_relative 'version' unless defined? Kolorit::VERSION
 
 module Kolorit
+  ##
+  # Require `win32console` to work on windows 10.
+  #
   module Windows
     begin
-      raise RuntimeError, 'Windows require Cygwin' unless Kolorit.win_32_console?
+      raise StandardError, 'Windows require Cygwin' unless Kolorit.win_32_console?
+
       require 'win32console'
     rescue LoadError => e
       raise 'Run: $ gem install win32console' if e.message =~ /win32console/
+
       raise e.message
     end
     # Windows without cygwin is not supported, so if we come this far,

data/lib/kolorit.rb

@@ -22,7 +22,6 @@ require_relative 'kolorit/version' unless defined? Kolorit::VERSION
 module Kolorit
 end
 
-
 if Kolorit.win? && !defined?(Kolorit::Windows)
   require_relative 'kolorit/windows'
   include(Kolorit::Windows)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kolorit
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.dev
+  version: 0.2.0
 platform: ruby
 authors:
 - alx3dev
@@ -11,36 +11,37 @@ cert_chain: []
 date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '13.0'
 description: |
-  Colorize terminal output without touching String class.
+  Colorize terminal output without touching core classes.
   Work for Linux and Mac, require `win32console` for Windows.
+  Use on any class, auto #puts or #print, with power of ruby blocks.
 email:
 - alx3dev@gmail.com
 executables: []
@@ -61,8 +62,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.2.0.pre.dev
-  license_uri: https://www.github.com/alx3dev/kolorit/LICENSE
+  documentation_uri: https://rubydoc.info/gems/kolorit/0.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -74,9 +74,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.6
 signing_key: