RubyGems - concolor - Versions diffs - 0.0.1 → 1.0.1 - Mend

concolor 0.0.1 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d9e9fd05bfc0ea172b309e228d210cf66f0e65fb
-  data.tar.gz: 8d9c36c5e198bcc9520d697441139c87b954026f
+SHA256:
+  metadata.gz: f42aa4a0c9aa77f70af7aaa9889cebc7d3f85384e5e509eb3c26c865bc2de573
+  data.tar.gz: ace991096094325ef9d0b23ebcd27053e2aba6a1d24bfdd40d517bef94739469
 SHA512:
-  metadata.gz: 0c5ef66dcb2e3c645ecadfa16b711b375f32620912534d62db377206b3c9cc10ed148584e6484773a8bea613c0d510cc2ac44b29e3d56bbb53d153c3ab929854
-  data.tar.gz: f390b29a7b64b9225af2d036d5de046e8cc054327165df67884a55644735944b3461db75567bf858e3c6f4fe4c97ac33eadcbc74bc80c0401b53e241524028be
+  metadata.gz: 9c8aead6bbcb153f25e7d203465b19b5bd295a6f0da0c73fc7a5c1b5da1ddfe6f5f35412a8956e5b8430f8aaaad53ff1ac52da8c6b57c593e486760714f73e1b
+  data.tar.gz: 20220bab5562b31a0d355ae680fcd982cb681f79d5dad575380e7fc0037048a7df8e4a37630b3a77fdd5fe3f422f6b97979c6f59408231b07503942c30285716

data/LICENSE.txt CHANGED Viewed

@@ -1,4 +1,4 @@
-Copyright (c) 2015 RubyBeast
+Copyright (c) 2022 BitForge
 MIT License

data/README.md CHANGED Viewed

@@ -1,23 +1,103 @@
 # Concolor
-TODO: Write a gem description
+[![Gem](https://img.shields.io/gem/v/concolor?color=e9573f&include_prereleases&logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/concolor) [![Ruby CI](https://img.shields.io/github/actions/workflow/status/bf-rb/concolor/ci.yml?branch=main&label=Ruby%20CI&logo=githubactions&style=for-the-badge)](https://github.com/bf-rb/concolor/actions) [![RubyDoc](https://img.shields.io/badge/RubyDoc-e2e2e2.svg?style=for-the-badge&logo=readme)](https://bf-rb.github.io/concolor/v1.0.1/)
+With `Concolor` you can change the fore- and background colors and text decorations when rendering text on terminals supporting ANSI escape codes. It adds the `concolor` method to `String` objects.
+![License](https://img.shields.io/github/license/bf-rb/concolor?style=for-the-badge) ![Stars](https://img.shields.io/github/stars/bf-rb/concolor?color=E3B341&logo=github&logoColor=E3B341&style=for-the-badge) ![Forks](https://img.shields.io/github/forks/bf-rb/concolor?color=000&logo=github&logoColor=000&style=for-the-badge) ![Watchers](https://img.shields.io/github/watchers/bf-rb/concolor?logo=github&style=for-the-badge)
+## Used technologies, API, tools, etc
+[ruby-logo]: https://img.shields.io/badge/Ruby-cc342d.svg?style=flat&logo=ruby&logoColor=fff
+[git-logo]: https://img.shields.io/badge/Git-000.svg?style=flat&logo=git&logoColor=f54d27
+[github-actions-logo]: https://img.shields.io/badge/GitHub%20Actions-2671e5.svg?style=flat&logo=githubactions&logoColor=fff
+[rubocop-logo]: https://img.shields.io/badge/RuboCop-f5f5f5.svg?style=flat&logo=rubocop&logoColor=000
+[vs-code-logo]: https://img.shields.io/badge/VS%20Code-2c2c32.svg?style=flat&logo=visualstudiocode&logoColor=22a8f1
+[docker-logo]: https://img.shields.io/badge/Docker-003f8c.svg?style=flat&logo=docker&logoColor=fff
+[ruby-gems-logo]: https://img.shields.io/badge/Ruby%20Gems-e9573f.svg?style=flat&logo=rubygems&logoColor=fff
+[![ruby-logo]](https://www.ruby-lang.org/) [![git-logo]](https://git-scm.com/) [![github-actions-logo]](https://docs.github.com/en/actions) [![rubocop-logo]](https://rubocop.org/) [![vs-code-logo]](https://code.visualstudio.com/) [![docker-logo]](https://www.docker.com/) [![ruby-gems-logo]](https://rubygems.org/)
+## Development
+Gem development information and current project status:
+[![Ruby CI](https://img.shields.io/github/actions/workflow/status/bf-rb/concolor/ci.yml?branch=dev&label=Ruby%20CI&logo=githubactions&style=for-the-badge)](https://github.com/bf-rb/concolor/actions) [![Open issues](https://img.shields.io/github/issues-raw/bf-rb/concolor?color=red&logo=github&style=for-the-badge)](https://github.com/bf-rb/concolor/issues) ![Closed issues](https://img.shields.io/github/issues-closed-raw/bf-rb/concolor?logo=github&style=for-the-badge)
 ## Installation
-Add this line to your application's Gemfile:
+Just install the *concolor* gem
+```bash
+gem install concolor
+```
+or if you use **bundler** put this in your `Gemfile`
 ```ruby
 gem 'concolor'
 ```
-And then execute:
+## Usage
-    $ bundle
+```ruby
+require 'concolor'
-Or install it yourself as:
+puts 'Some text'.concolor(:bold, :red)
+# "\033[31;1mSome text\033[0m"
+```
-    $ gem install concolor
+### Foreground color & Background color
-## Usage
+[#000000]: https://via.placeholder.com/15/000000/000000.png
+[#CD0000]: https://via.placeholder.com/15/CD0000/CD0000.png
+[#00CD00]: https://via.placeholder.com/15/00CD00/00CD00.png
+[#CDCD00]: https://via.placeholder.com/15/CDCD00/CDCD00.png
+[#1E90FF]: https://via.placeholder.com/15/1E90FF/1E90FF.png
+[#CD00CD]: https://via.placeholder.com/15/CD00CD/CD00CD.png
+[#00CDCD]: https://via.placeholder.com/15/00CDCD/00CDCD.png
+[#E5E5E5]: https://via.placeholder.com/15/E5E5E5/E5E5E5.png
+[#4C4C4C]: https://via.placeholder.com/15/4C4C4C/4C4C4C.png
+[#FF0000]: https://via.placeholder.com/15/FF0000/FF0000.png
+[#00FF00]: https://via.placeholder.com/15/00FF00/00FF00.png
+[#FFFF00]: https://via.placeholder.com/15/FFFF00/FFFF00.png
+[#4682B4]: https://via.placeholder.com/15/4682B4/4682B4.png
+[#FF00FF]: https://via.placeholder.com/15/FF00FF/FF00FF.png
+[#00FFFF]: https://via.placeholder.com/15/00FFFF/00FFFF.png
+[#FFFFFF]: https://via.placeholder.com/15/FFFFFF/FFFFFF.png
+| Foreground color | code |   color    | Background color   | code  |
+| :--------------- | :--: | :--------: | :----------------- | :---: |
+| `:default`       | *29* |            | `:bg_default`      | *49*  |
+| `:black`         | *30* | ![#000000] | `:bg_black`        | *40*  |
+| `:red`           | *31* | ![#CD0000] | `:bg_red`          | *41*  |
+| `:green`         | *32* | ![#00CD00] | `:bg_green`        | *42*  |
+| `:yellow`        | *33* | ![#CDCD00] | `:bg_yellow`       | *43*  |
+| `:blue`          | *34* | ![#1E90FF] | `:bg_blue`         | *44*  |
+| `:magenta`       | *35* | ![#CD00CD] | `:bg_magenta`      | *45*  |
+| `:cyan`          | *36* | ![#00CDCD] | `:bg_cyan`         | *46*  |
+| `:light_gray`    | *37* | ![#E5E5E5] | `:bg_light_gray`   | *47*  |
+| `:dark_gray`     | *90* | ![#4C4C4C] | `:bg_dark_gray`    | *100* |
+| `:light_red`     | *91* | ![#FF0000] | `:bg_light_red`    | *101* |
+| `:light_green`   | *92* | ![#00FF00] | `:bg_light_green`  | *102* |
+| `:light_yellow`  | *93* | ![#FFFF00] | `:bg_light_yellow` | *103* |
+| `:light_blue`    | *94* | ![#4682B4] | `:bg_light_blue`   | *104* |
+| `:light_magenta` | *95* | ![#FF00FF] | `:bg_light_magenta`| *105* |
+| `:light_cyan`    | *96* | ![#00FFFF] | `:bg_light_cyan`   | *106* |
+| `:white`         | *97* | ![#FFFFFF] | `:bg_white`        | *107* |
+### Mode (modifying the style of text)
-TODO: Write usage instructions here
+| Symbol        | Description | code |
+| :------------ | :---------- | :---: |
+| `:reset`      | Reset all SGR effects to their default | *0* |
+| `:bold`       | Bold or increased intensity | *1* |
+| `:faint`      | Faint or decreased intensity | *2* |
+| `:italic`     | Italic | *3* |
+| `:underline`  | Singly underlined | *4* |
+| `:blink`      | Blink (slow)  | *5* |
+| `:blink_fast` | Blink (fast)  | *6* |
+| `:reverse`    | Reverse (invert the foreground and background colors) | *7* |
+| `:hide`       | Hidden (useful for passwords) | *8* |
+| `:cross`      | Cross-out | *9* |

data/Rakefile CHANGED Viewed

@@ -1 +1,12 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+task default: %i[spec rubocop]

data/lib/concolor/extension.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Concolor
+  # Extension module
+  #
+  # @example
+  #   class CustomString < String
+  #     include Concolor::Extension
+  #   end
+  #
+  #   CustomString.new('Some text').concolor(:bold, :red)
+  #   # => "\033[31;1mSome text\033[0m"
+  #
+  # @since 0.0.1
+  module Extension
+    # @param options [Array<Symbol>]
+    # @return [Concolor::String]
+    def concolor(*options)
+      ::Concolor::String.new(to_s, options: options)
+    end
+  end
+end

data/lib/concolor/mappers.rb ADDED Viewed

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module Concolor
+  # ANSI escape codes mappers
+  #
+  # @since 1.0.1
+  module Mappers
+    COLORS = {
+      default: 39,
+      black: 30,
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      magenta: 35,
+      cyan: 36,
+      light_gray: 37,
+      dark_gray: 90,
+      light_red: 91,
+      light_green: 92,
+      light_yellow: 93,
+      light_blue: 94,
+      light_magenta: 95,
+      light_cyan: 96,
+      white: 97
+    }.freeze
+    BG_COLORS = {
+      bg_default: 49,
+      bg_black: 40,
+      bg_red: 41,
+      bg_green: 42,
+      bg_yellow: 43,
+      bg_blue: 44,
+      bg_magenta: 45,
+      bg_cyan: 46,
+      bg_light_gray: 47,
+      bg_dark_gray: 100,
+      bg_light_red: 101,
+      bg_light_green: 102,
+      bg_light_yellow: 103,
+      bg_light_blue: 104,
+      bg_light_magenta: 105,
+      bg_light_cyan: 106,
+      bg_white: 107
+    }.freeze
+    MODES = {
+      reset: 0,
+      bold: 1,
+      faint: 2,
+      italic: 3,
+      underline: 4,
+      blink: 5,
+      blink_fast: 6,
+      reverse: 7,
+      hide: 8,
+      cross: 9
+    }.freeze
+  end
+end

data/lib/concolor/string.rb ADDED Viewed

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+module Concolor
+  # Extension module for String class
+  #
+  # @since 1.0.1
+  class String
+    # @param str [String] some string object
+    # @param options [Array<Symbol>]
+    def initialize(str = '', options: [])
+      @str = str
+      parsed = parse_options!(options)
+      @color = ::Concolor::Mappers::COLORS[parsed[:colors].first]
+      @bg_color = ::Concolor::Mappers::BG_COLORS[parsed[:bg_colors].first]
+      @modes = parsed[:modes].map do |mode|
+        Concolor::Mappers::MODES[mode]
+      end
+    end
+    # To string
+    #
+    # @return [String]
+    def to_s
+      "\033[#{style}m#{@str}\033[0m"
+    end
+    alias inspect to_s
+    private
+    # Parse options
+    #
+    # @param options [Array<Symbol>]
+    # @return [Hash] { colors: [...], bg_colors: [...], modes: [...] }
+    def parse_options!(options)
+      parsed = { colors: [], bg_colors: [], modes: [] }
+      wrong = []
+      options.each do |opt|
+        if Concolor::Mappers::COLORS.key?(opt)
+          parsed[:colors].push(opt)
+        elsif Concolor::Mappers::MODES.key?(opt)
+          parsed[:modes].push(opt)
+        elsif Concolor::Mappers::BG_COLORS.key?(opt)
+          parsed[:bg_colors].push(opt)
+        else
+          wrong.push(opt)
+        end
+      end
+      return parsed if wrong.empty?
+      raise ::ArgumentError, "Wrong options: #{wrong.join(', ')}"
+    end
+    # Get style string
+    #
+    # @return [String]
+    def style
+      [@color, @bg_color, @modes].flatten.compact.join(';')
+    end
+  end
+end

data/lib/concolor/version.rb CHANGED Viewed

@@ -1,4 +1,35 @@
-# coding: utf-8
+# frozen_string_literal: true
 module Concolor
-  VERSION = '0.0.1'
-end
+  # Gem version module
+  #
+  # @since 0.0.1
+  module Version
+    # x.0.0 changes that will break existing users code if they update
+    MAJOR = 1
+    # 0.x.0 changes, such as new functionality/features
+    MINOR = 0
+    # 0.0.x changes, such as small bug fixes
+    PATCH = 1
+    # Get current gem version
+    #
+    # @example
+    #   Concolor::Version::CURRENT # => "1.0.1"
+    #
+    # @since 1.0.1
+    CURRENT = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    # Get current gem version
+    #
+    # @deprecated use {CURRENT} instead.
+    #
+    # @example
+    #   Concolor::Version.current # => "0.0.1"
+    #
+    # @return [String]
+    def self.current
+      "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

data/lib/concolor.rb CHANGED Viewed

@@ -1,47 +1,18 @@
-# coding: utf-8
-require 'concolor/version'
+# frozen_string_literal: true
+# Base module
+#
+# @author {https://github.com/alexmercury Alex Merkulov}
 module Concolor
-  def style(*args)
-    style_map = {
-        # Text color
-        black: 30,
-        red: 31,
-        green: 32,
-        yellow: 33,
-        blue: 34,
-        magenta: 35,
-        cyan: 36,
-        white: 37,
-        # Background color
-        black_bg: 40,
-        red_bg: 41,
-        green_bg: 42,
-        yellow_bg: 43,
-        blue_bg: 44,
-        magenta_bg: 45,
-        cyan_bg: 46,
-        white_bg: 47,
-        # Text Style
-        bold: 1,
-        underline: 4
-    }
-    colorize_string = self.to_s
-    args.each do |arg|
-      if style_map.key?(arg)
-        colorize_string = "\033[#{style_map[arg]}m" + colorize_string + "\033[0m"
-      end
-    end
-    colorize_string
+  autoload :Version, 'concolor/version'
+  autoload :Mappers, 'concolor/mappers'
+  autoload :String, 'concolor/string'
+  autoload :Extension, 'concolor/extension'
+  # @param klass [Class]
+  def self.auto_include_to(klass)
+    klass.send(:include, Concolor::Extension)
   end
 end
-class String
-  include Concolor
-end
+Concolor.auto_include_to(String)

metadata CHANGED Viewed

@@ -1,46 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: concolor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
-- alexmercury
-autorequire:
+- Alex Merkulov
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+date: 2023-05-17 00:00:00.000000000 Z
+dependencies: []
 description: Colorize console text
 email:
-- rubybeastua@gmail.com
+- rormercury@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -49,12 +21,21 @@ files:
 - README.md
 - Rakefile
 - lib/concolor.rb
+- lib/concolor/extension.rb
+- lib/concolor/mappers.rb
+- lib/concolor/string.rb
 - lib/concolor/version.rb
-homepage: https://github.com/rubybeast/concolor
+homepage: https://github.com/bf-rb/concolor
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/bf-rb/concolor
+  changelog_uri: https://github.com/bf-rb/concolor/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/bf-rb/concolor
+  documentation_uri: https://bf-rb.github.io/concolor/v1.0.1
+  bug_tracker_uri: https://github.com/bf-rb/concolor/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,16 +43,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.5
-signing_key:
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
-summary: Console color
+summary: Console colorize text
 test_files: []