kolorit 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef040c50bebe6a3d79fcaee8de83f9bd97233b9e432d6a232db7137beff88643
-  data.tar.gz: c262eabd58497efbfa76e72d918c1b2a6445c2a7dec772a0cbd67c97722d5b86
+  metadata.gz: bb708f14550d48ef0bc7715e54948c60310eae2b1b630c664727edec7ffd5a20
+  data.tar.gz: b03cb0001044f58e519b414235b49e9e6574e7af3c55f4a26dd2d67b8c768205
 SHA512:
-  metadata.gz: 0dac1ce53413bc676b2d03a0d3be3b8b27129ab02f2137dca9112e9ded142d184c320912b7560fd59b377564d3edcf95131ae3b6e372e6b001a3f2b493d45806
-  data.tar.gz: 63cd157d5400ac32f2eeca5e0b7af678175f5f3e94dc464175b8269ed1ecde08d9632ec52e5023e89e2096005dad35b05c6a62a92baf2d2455445595d5758443
+  metadata.gz: 7abc3838e802e519a0c1657ba29994abefb11aa331a9d147ffbea2529437e33ee9abb9f51f2be6ece8a6eed9d8dff691257504a7f733e28065ae0a52c64c05dd
+  data.tar.gz: e25dd52f426f1107cee3755d63001a7842692673e18f3342d18d5af342493be42f5ca0e24891d933338a0730b74b2625f25a5838a4c8a4332de5e03bd3f0b7b3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Alex3Dev
+
+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,130 @@
+# Kolorit
+
+![GIF Preview](demo.gif)
+
+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.
+
+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.
+
+# How to install
+
+GitHub repo is always updated before rubygems.
+```bash
+git clone https://www.github.com/alx3dev/kolorit.git
+cd kolorit
+bundle install
+```
+
+Install from rubygems:
+```bash
+gem install kolorit
+```
+
+# How to use:
+
+ - Include kolorit methods, allow use on string, integer, array, hash
+
+```ruby
+# 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
+
+```
+
+ - 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
+
+blue 'some string'
+red 'red bold string'
+```
+
+`#colorize` accept color as first argument, and string as second  
+`#kolorize` accept string as first 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 colorized.
+
+You can allow methods to automatically `#puts` or `#print` colorized string:
+
+```ruby
+# this call without arguments is same as with :puts
+Kolorit.output :puts
+# or
+Kolorit.output :print
+
+# everything else is same as false
+Kolorit.output false
+```
+
+Enable or disable colorization globally:
+
+```ruby
+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

@@ -1,52 +1,154 @@
 # frozen_string_literal: true
 
+require_relative 'version' unless defined? Kolorit::VERSION
+
 module Kolorit
+  ##
+  # Color codes for Linux systems.
+  # Allow use of color methods in many different ways.
+  #
+  # Include methods outside of main module to use them directly
+  # on string (or integer, array, hash). This is done when you call
+  # `require 'kolorit'`. You can also just include it in class
+  # where you want to use it:
+  #
+  # @example Include Kolorit::Linux in just one class
+  #
+  #   class MyClass
+  #     require 'kolorit/linux'
+  #     include Kolorit::Linux
+  #     # rest_of_code
+  #   end
+  #
+  # @example Use color named methods
+  #
+  #   red 'Hello Red Ruby!'
+  #   # or
+  #   green 'Hello Green Ruby!'
+  #
+  # @example Use colorize/kolorize methods
+  #
+  #   colorize :red, 'Hello Red Ruby!'
+  #   # or
+  #   kolorize 'Ruby goes green, again!', :green
+  #
+  # @example Colorize also accept block
+  #
+  #   # colorize accept color as first argument
+  #
+  #   colorize(:green) do
+  #     case @var = SomeClass.call_some_method
+  #     when 'some response'
+  #       "do_something_with_response #{@var}"
+  #     else
+  #       # in this situation #red has precedence over #green
+  #       red("Returned Error for #{@var}")
+  #     end
+  #   end
+  #
+  #   # kolorize accept string as first argument
+  #
+  #   kolorize(@result) { @result.is_a?(String) ? :green : :red }
+  #
+  # @see Kolorit
+  # @see https://www.github.com/alx3dev/kolorit/README.md
+  #
   module Linux
-    def black = colorize(30)
+    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 red = colorize(31)
+    def blue(str = nil)
+      kolor(34, str)
+    end
 
-    def green = colorize(32)
+    def pink(str = nil)
+      kolor(35, str)
+    end
 
-    def yellow = colorize(33)
+    def cyan(str = nil)
+      kolor(36, str)
+    end
 
-    def blue = colorize(34)
+    def gray(str = nil)
+      kolor(37, str)
+    end
 
-    def pink = colorize(35)
+    def bold(str = nil)
+      kolor(1, str)
+    end
 
-    def cyan = colorize(36)
+    def italic(str = nil)
+      kolor(3, str)
+    end
 
-    def gray = colorize(37)
+    def underline(str = nil)
+      kolor(4, str)
+    end
 
-    def bold = colorize(1)
+    def blink(str = nil)
+      kolor(5, str)
+    end
 
-    def italic = colorize(3)
+    def reverse_color(str = nil)
+      kolor(7, str)
+    end
 
-    def underline = colorize(4)
+    alias inverse reverse_color
 
-    def blink = colorize(5)
+    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 reverse_color = colorize(7)
+    def kolorize(string, color = nil, &blk)
+      color = yield(blk) if block_given?
+      color = KOLORS[color.to_sym] unless color.is_a?(Integer)
+      kolor color, string
+    end
 
     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"
+    def kolor(color, param = nil)
+      param = self if param.nil?
+      string = color_style color, param
+      unless (1..7).include? color
+        case Kolorit.output?
+        when :puts  then puts string
+        when :print then print string
+        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,
+             blue: 34, pink: 35, cyan: 36,
+             gray: 37, bold: 1, italic: 3,
+             underline: 4, blink: 5, inverse: 7 }.freeze
 end

data/lib/kolorit/version.rb

@@ -1,6 +1,51 @@
 # 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.1.3'
+  VERSION = '0.2.0'
+
+  class << self
+    def win_32_console?
+      win? && cygwin?
+    end
+
+    def win?
+      ENV['OS'] == 'Windows_NT'
+    end
+
+    def cygwin?
+      RUBY_PLATFORM =~ /cygwin/
+    end
+
+    def enabled?
+      @enable != false
+    end
+
+    def enable(color: true)
+      @enable = color.is_a? TrueClass
+    end
+    alias enable= enable
+
+    def disable
+      enable color: false
+    end
+
+    def output?
+      @output
+    end
+
+    def output(settings = :puts)
+      @output = settings
+      @output = nil if settings.is_a? FalseClass
+      @output = :puts if settings.is_a? TrueClass
+    end
+    alias output= output
+  end
 end

data/lib/kolorit/windows.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'version' unless defined? Kolorit::VERSION
+
+module Kolorit
+  ##
+  # Require `win32console` to work on windows 10.
+  #
+  module Windows
+    begin
+      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,
+    # include Linux color codes.
+    require_relative 'linux' unless defined? Kolorit::Linux
+    include Kolorit::Linux
+  end
+end

data/lib/kolorit.rb

@@ -1,19 +1,31 @@
 # frozen_string_literal: true
 
-require_relative 'kolorit/version'
+require_relative 'kolorit/version' unless defined? Kolorit::VERSION
 
+##
+# Colorize terminal output without touching String class.
+# Work for Linux and Mac, require `win32console` for Windows.
+#
+# @example Use it any way you like
+#  require 'kolorit'
+#
+#  puts colorize :red, 'this is red string'
+#
+#  puts blue 'this is blue string'
+#
+#  puts 'this is green string'.green
+#
+#  puts cyan 'this is cyan string, make it bold!'.bold
+#
+# @see Kolorit::Linux
+#
 module Kolorit
 end
 
-if ENV['OS'] == 'Windows_NT'
-  # require_relative 'kolorit/windows'
-  class String
-    # working on windows color codes
-    # include Kolorit::Windows unless RUBY_PLATFORM =~ /cygwin/
-  end
-else
+if Kolorit.win? && !defined?(Kolorit::Windows)
+  require_relative 'kolorit/windows'
+  include(Kolorit::Windows)
+elsif !defined?(Kolorit::Linux)
   require_relative 'kolorit/linux'
-  class String
-    include Kolorit::Linux
-  end
+  include(Kolorit::Linux)
 end

metadata

@@ -1,27 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: kolorit
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
-dependencies: []
+date: 2022-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: |
-  Print your terminal output in different colors. Early development stage,
-  for now only Linux and Mac. MIT license.'
+  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: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/kolorit.rb
 - lib/kolorit/linux.rb
 - lib/kolorit/version.rb
+- lib/kolorit/windows.rb
 homepage: https://www.github.com/alx3dev/kolorit
 licenses:
 - MIT
@@ -30,7 +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
+  documentation_uri: https://rubydoc.info/gems/kolorit/0.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -40,17 +72,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.6.0
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: 4.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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.
+summary: Colorize terminal output on Linux, Mac and Windows.
 test_files: []