kolorit 0.1.5 → 0.2.0.pre.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdbfa5dc4a917af5db6c5af7d92c29784754f17afe28e28b9e9b2183bc30812d
-  data.tar.gz: 9c0c4f30ec7147f8b0ef26a794aca493a58eb150a050bb9f9004480efdb4bd0d
+  metadata.gz: f5e2ca034fd3bfb8d36f988cc12e9014fea4ae1aae98a21f5312e1752b53931e
+  data.tar.gz: a317b400ccd1adf91302ec9a451a6ef9b6cb5878ba6e7589f18d64c98e742cb3
 SHA512:
-  metadata.gz: 312362814ac515dd8ab83a13531ea3fbbae6abade783a78f640b288869c9e0cdf0d36c1b9be8607328835373a1cb63d95f77081ac2c23fdf9c5c5ec8eff202f7
-  data.tar.gz: 58e3143322813034aee0ebc4fc57d8edf29fa5048fecec0005898aa26b2b5c0661b55d827ca1b4785ee103ea852ca49ebdff88a6c776865c31352b038dfa30cc
+  metadata.gz: c727a260c985a1b711c2caf3f8fc289034ab9b921c75db344ff531f7aec94af5d693dda8c9c9d60bedca754fe0336671e43f208ef0adac70828c91e79eea9621
+  data.tar.gz: f04a0ab07f3eeae402faa39d3b58b44a14e9e95c1aed2319500fdc90da15ed5131deb99677d7387642b29ec037799b5eb9f24a9fc04f86eda51109e98adf2b90

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,102 @@
+# 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.
+
+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.
+
+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)
+
+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
+```
+
+Usage:
+
+ - Include kolorit methods, allow use on string, integer, array, hash
+
+```ruby
+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
+require 'kolorit/linux' # or 'kolorit/windows'
+
+include Kolorit::Linux # or ::Windows
+
+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
+
+@var = 'SUCCESS!'
+kolorize(@var) { @var.nil? ? :red : :green }
+```
+
+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
+```

data/lib/kolorit/linux.rb

@@ -1,96 +1,115 @@
 # frozen_string_literal: true
 
+require_relative 'version' unless defined? Kolorit::VERSION
+
 module Kolorit
   ##
-  # kolor codes for linux systems.
-  # Allow use of kolor methods when included in class.
+  # 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
   #
-  # @todo Use `def red = kolor(int)` in ruby > 3.0
-  #
   module Linux
-    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 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 cyan
-      kolor(36)
-    end
-
-    def gray
-      kolor(37)
-    end
-
-    def bold
-      kolor(1)
-    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 italic
-      kolor(3)
-    end
+    alias inverse reverse_color
 
-    def underline
-      kolor(4)
+    def colorize(color, string = nil, &blk)
+      string = yield(blk) if block_given?
+      kolor color, string
     end
 
-    def blink
-      kolor(5)
+    def kolorize(string, color = nil, &blk)
+      color = block_given? ? yield(blk) : :cyan
+      kolor color, string
     end
 
-    def reverse_color
-      kolor(7)
-    end
-    alias inverse reverse_color
+    private
 
-    # @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
+    def kolor(color, param = nil)
+      param = self if param.nil?
+      return param unless Kolorit.enabled?
 
-    private
+      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
 
-    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"
+      string = "\e[#{color}m#{param}\e[#{style}m"
+      case Kolorit.output?
+        when :puts  then puts string
+        when :print then print string
+      end unless (1..7).include? color
+      string
     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

@@ -2,5 +2,49 @@
 
 module Kolorit
   # gem version
-  VERSION = '0.1.5'
+  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
+  #
+  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(param = true)
+      @enable = param.is_a? TrueClass
+    end
+    alias enable= enable
+
+    def disable
+      enable 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,19 @@
+# frozen_string_literal: true
+
+require_relative 'version' unless defined? Kolorit::VERSION
+
+module Kolorit
+  module Windows
+    begin
+      raise RuntimeError, '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,63 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'kolorit/version'
+require_relative 'kolorit/version' unless defined? Kolorit::VERSION
 
 ##
-# Handle modules with color codes and methods to colorize string.
-# Right module is included depending on user OS.
+# Colorize terminal output without touching String class.
+# Work for Linux and Mac, require `win32console` for Windows.
 #
-# @example (opt 1) - Require everything and override String class
-#  require 'kolorit' => include color methods in class String
+# @example Use it any way you like
+#  require 'kolorit'
 #
-# @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
+#  puts colorize :red, 'this is red string'
 #
-# @example Colorize string
-#  'I am mr Red String'.red
-#  'I am mr Green String'.green
-#  'I am bold (fat) mis Pink String'.pink.bold
+#  puts blue 'this is blue string'
 #
-# @example Available colors
-#  red, green, yellow, blue, pink, cyan, gray
+#  puts 'this is green string'.green
 #
-# @example Available styles
-#  bold, italic, underline, blink, reverse_color
+#  puts cyan 'this is cyan string, make it bold!'.bold
+#
+# @see Kolorit::Linux
 #
 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 Kolorit.windows? && !defined?(Kolorit::Windows)
+if Kolorit.win? && !defined?(Kolorit::Windows)
   require_relative 'kolorit/windows'
-  klass.include Kolorit::Windows
-
+  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
+  require_relative 'kolorit/linux'
+  include(Kolorit::Linux)
 end

metadata

@@ -1,28 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: kolorit
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0.pre.dev
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-30 00:00:00.000000000 Z
-dependencies: []
+date: 2022-02-08 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
 description: |
-  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.
+  Colorize terminal output without touching String class.
+  Work for Linux and Mac, require `win32console` for Windows.
 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
@@ -31,7 +61,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.5
+  documentation_uri: https://rubydoc.info/gems/kolorit/0.2.0.pre.dev
   license_uri: https://www.github.com/alx3dev/kolorit/LICENSE
 post_install_message:
 rdoc_options: []
@@ -42,17 +72,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.6.0
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 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: []