colora 0.1.240114

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3760588ff62affbf6a8f1c58a95e9d76415d77db9fd9d214a783e51dad1d177
+  data.tar.gz: 6422c39bc7dc14d01575da4af643f5029a06f8e7db15a22fff72655ba468b199
+SHA512:
+  metadata.gz: 87dcb061cc8f77823edda88f80ad60f3c5abc3bccd199504cbab391c7615853b58e682b04d97b9fa2cee5665dfb9e46b2a8fe35e05184724c984d71526ac5b9b
+  data.tar.gz: c17e22167482923f6900ba3e614bdf25cee992496fe789d6a57cc344b0821653b9585cf22ed106960b483c0bac451780bff7035b929b82cdb5d83636cf2b43cd

data/README.md

@@ -0,0 +1,112 @@
+# Colora
+
+* [VERSION 0.1.240114](https://github.com/carlosjhr64/colora/releases)
+* [github](https://www.github.com/carlosjhr64/colora)
+* [rubygems](https://rubygems.org/carlosjhr64/colora)
+
+## DESCRIPTION
+
+Colorizes terminal outputs.
+
+Uses `Rouge::Formatters::Terminal256` to theme/color output to the terminal.
+Color codes git diff.
+
+## INSTALL
+```console
+$ gem install colora
+```
+## SYNOPSIS
+```console
+$ colora ./README.md     # Color outputs file
+$ cat README.md | colora # Colorizing filter
+$ colora --git lib       # Git-diff with target
+$ colora                 # Git-diff default
+```
+## GIT-DIFF FILTERING
+
+![Demo](img/demo.png)
+
+Colora will decorate your git-diff output with the following additional flags:
+
+* Absent: `*`
+* Deleted: `<`
+* Inserted: `>`
+* Moved/Touched: `t`
+* Edited: `e`
+* Duplicated: `d`
+
+The flags are the first three characters of the diff line,
+the first coming from git.
+The second and third refer to the code and comment of the diff line
+(Colora assumes comments as in Ruby).
+One can choose to filter(via command line options) the diff output to:
+
+* Filter out context lines(quiet)
+* Just view green(inserted lines)
+* Just view red(deleted lines)
+* Just view edited code or comments
+* Just view duplicated code or comments
+
+Additional features:
+
+* Swap tabs with tab symbol
+* Switch to a different theme(as provided by Rouge)
+
+## HELP
+```console
+$ colora --help
+Usage:
+  colora [:options+] [<file=FILE>]
+Options:
+  -q --quiet
+  -g --green     	 Skip red:   /^[-<]/
+  -r --red       	 Skip green: /^[+>]/
+  -c --code      	 Show only new(changed) code
+  -C --comment   	 Show only new(changed) comments
+  -d --dupcode   	 Show only duplicate code
+  -D --dupcomment	 Show only duplicate comments
+  -G --git       	 Run git-diff
+  -t --tab       	 Swap tab with ⇥
+  --theme=NAME   	 Rouge theme(default: github)
+  --lang=NAME    	 Language being diffed(default: ruby)
+Types:
+  FILE /^[-\w\.\/]+$/
+  NAME /^[\d.a-z_]+$/
+Exclusive:
+  green red
+# Notes: #
+When no FILE is given and STDIN in a TTY, git-diff is run.
+Known themes:
+  base16 base16.monokai base16.solarized bw
+  colorful
+  github gruvbox
+  igorpro
+  magritte molokai monokai monokai.sublime
+  pastie
+  thankful_eyes tulip
+```
+## LICENSE
+
+Copyright (c) 2024 CarlosJHR64
+
+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/bin/colora

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require 'colora'
+
+def parse_argv
+  return nil if ARGV.empty?
+
+  require 'help_parser'
+  HelpParser[Colora::VERSION, <<~HELP]
+    Usage:
+      colora [:options+] [<file=FILE>]
+    Options:
+      -q --quiet
+      -g --green     \t Skip red:   /^[-<]/
+      -r --red       \t Skip green: /^[+>]/
+      -c --code      \t Show only new(changed) code
+      -C --comment   \t Show only new(changed) comments
+      -d --dupcode   \t Show only duplicate code
+      -D --dupcomment\t Show only duplicate comments
+      -G --git       \t Run git-diff
+      -t --tab       \t Swap tab with ⇥
+      --theme=NAME   \t Rouge theme(default: github)
+      --lang=NAME    \t Language being diffed(default: ruby)
+    Types:
+      FILE /^[-\\w\\.\\/]+$/
+      NAME /^[\\d.a-z_]+$/
+    Exclusive:
+      green red
+    # Notes: #
+    When no FILE is given and STDIN in a TTY, git-diff is run.
+    Known themes:
+      base16 base16.monokai base16.solarized bw
+      colorful
+      github gruvbox
+      igorpro
+      magritte molokai monokai monokai.sublime
+      pastie
+      thankful_eyes tulip
+  HELP
+end
+
+options = parse_argv
+begin
+  Colora.run(options)
+rescue Colora::Error => e
+  warn e.message
+end

data/lib/colora/configure.rb

@@ -0,0 +1,40 @@
+module Colora
+  Config = OpenStruct.new
+
+  # Options:
+  Config.file   = nil
+  Config.git    = false
+  Config.lang   = 'ruby'
+  Config.theme  = 'github'
+  Config.tab    = false
+
+  # Filter keys:
+  FILTERS = %i[quiet green red code comment dupcode dupcomment]
+  FILTERS.each{Config[_1]=false}
+
+  # Flags colors:
+  Config.duplicated_flag = [:default, '#E0FFFF'] # LightCyan
+  Config.inserted_flag   = [:default, '#ADD8E6'] # LightBlue
+  Config.edited_flag     = [:default, '#90EE90'] # LightGreen
+
+  # Comments colors:
+  Config.moved_comment      = ['#A9A9A9', :default] # DarkGray
+  Config.duplicated_comment = ['#008B8B', :default] # DarkCyan
+  Config.inserted_comment   = ['#00008B', :default] # DarkBlue
+  Config.edited_comment     = ['#006400', :default] # DarkGreen
+
+  def self.configure(options)
+    # FILE:
+    Config.file = options.file if options.file
+
+    # Options:
+    Config.theme = options.theme if options.theme?
+    Config.lang  = options.lang if options.lang?
+    Config.git   = options.git?
+    Config.tab   = options.tab?
+
+    # Filters:
+    # Config.quiet=options.quiet? ...
+    FILTERS.each{Config[_1]=options.send("#{_1}?")}
+  end
+end

data/lib/colora/data.rb

@@ -0,0 +1,83 @@
+module Colora
+  class Data
+    SPLIT = lambda do |line|
+      flag = line[0]
+      code, pounds, comment = line[1..].split(/(?<!['"])(\s*#+)(?!{)/, 2)
+      code = nil if code.empty?
+      comment ? [flag, code, pounds+comment] : [flag, code, nil]
+    end
+    UPDATE = lambda do |hash, key, flag|
+      k = key.strip
+      hash[k] = case hash[k]
+                when nil
+                    flag # added(+>) or removed(-<)
+                when 'd', 't', flag
+                    'd' # duplicate
+                else
+                    't' # touched
+                end
+    end
+
+    def pre_process(line)
+      # rubocop:disable Lint/DuplicateBranch
+      case line.rstrip
+      when '', '+', '-', '---', /^[-+][-+][-+] [ab]/
+        line
+      when /^[-+<>]/
+        flag, code, comment = SPLIT[line]
+        f = flag=='-' ? '<' : flag=='+' ? '>' : flag
+        UPDATE[@codes, code, f] if code
+        UPDATE[@comments, comment, f] if comment
+        [flag, code, comment]
+      else
+        line
+      end
+      # rubocop:enable Lint/DuplicateBranch
+    end
+
+    attr_reader :lines
+
+    def initialize(lines)
+      @lines,@codes,@comments,@edits = [],{},{},Set.new
+      while (line = lines.shift)
+        @lines << pre_process(line)
+      end
+      populate_edits
+      @lines.each do |line|
+        next unless line.is_a?(Array)
+        post_process line
+      end
+      @codes = @comments = @edits = nil # GC
+    end
+
+    def populate_edits
+      partners = []
+      jarrow = FuzzyStringMatch::JaroWinkler.create(:pure) # Need pure for UTF-8
+      removed = @codes.select{|_,flag| '-<'.include?flag}.keys
+      added   = @codes.select{|_,flag| '+>'.include?flag}.keys
+      short, long = [removed, added].sort_by(&:length)
+      short.each do |a|
+        long.each do |b|
+          d = jarrow.getDistance(a, b)
+          partners.push([a, b, d]) if d > 0.618034
+        end
+      end
+      partners.sort_by(&:last).reverse.each do |a, b, _|
+        next if @edits.include?(a) || @edits.include?(b)
+        @edits.add(a)
+        @edits.add(b)
+      end
+    end
+
+    def post_process(line)
+      if (code = line[1]&.strip)
+        flag = @edits.include?(code) ? 'e' : @codes[code]
+        line[1] = [flag, line[1]]
+      end
+      if (comment = line[2]&.strip)
+        flag = @comments[comment]
+        line[2] = [flag, line[2]]
+      end
+    end
+  end
+end

data/lib/colora/lines.rb

@@ -0,0 +1,108 @@
+module Colora
+  class Lines
+    def formatter
+      theme = Rouge::Theme.find(Config.theme)
+      raise Error, "Unrecognized theme: #{Config.theme}" unless theme
+      Rouge::Formatters::Terminal256.new(theme.new)
+    end
+
+    def get_lexer_by_file(file = Config.file)
+      return nil unless file && !File.extname(file).empty?
+      Rouge::Lexer.guess_by_filename(file)
+    end
+
+    def get_lexer_by_source(source)
+      case source
+      when /^---/, /^# /
+        Rouge::Lexer.guess_by_filename('*.md')
+      else
+        Rouge::Lexer.guess_by_source(source)
+      end
+    end
+
+    def filehandle
+      Config.git ? IO.popen("git diff #{Config.file}") :
+      Config.file ? File.open(Config.file) :
+                    $stdin
+    end
+
+    def get_lines(fh = filehandle)
+      fh.readlines.map(&:chomp)
+    end
+
+    def initialize
+      @formatter = formatter
+      lines  = get_lines
+      @lexer = @orig_lexer = get_lexer_by_file || get_lexer_by_source(lines[0])
+      @tag   = @lexer.tag
+      @lines = @tag=='diff' ? Data.new(lines).lines : lines
+      @lang  = @orig_lang = Rouge::Lexer.find_fancy(Config.lang)
+      @pad0  = '    '
+      @pad1  = '  '
+    end
+
+    def to_a = @lines
+
+    def filtered?(line)
+      return false if line.is_a?(String)
+
+      (Config.green && '-<'.include?(line[0])) ||
+        (Config.red && '+>'.include?(line[0])) ||
+        (Config.code && [nil,'t'].include?(line.dig 1,0)) ||
+        (Config.comment && [nil, 't'].include?(line.dig 2,0)) ||
+        (Config.dupcode && line.dig(1,0)=='d') ||
+        (Config.dupcomment && line.dig(2,0)=='d') ||
+        false
+    end
+
+    def pad(line)
+      @pad0+line
+    end
+
+    def flags(line)
+        line[0] + (line.dig(1,0)||'*') + (line.dig(2,0)||'*') + @pad1
+    end
+
+    def format(line, color=nil)
+      case color
+      when nil
+        @formatter.format(@lexer.lex(line))
+      when :lang
+        @formatter.format(@lang.lex(line))
+      else
+        Paint[line, *color]
+      end
+    end
+
+    def reset_lang_by_source(source)
+      @lang = Rouge::Lexer.guess_by_source(source)
+    end
+
+    def reset_lang_by_filename(file)
+      @lang = Rouge::Lexer.guess_by_filename(file)
+    end
+
+    def reset_lexer(lang=nil)
+      @lexer = lang.nil? ? @orig_lexer :
+                           (Rouge::Lexer.find_fancy(lang) || @orig_lexer)
+    end
+
+    def reset_lang(lang=nil)
+      @lang  = lang.nil? ? @orig_lang :
+                           (Rouge::Lexer.find_fancy(lang) || @orig_lang)
+    end
+
+    def each
+      @lines.each do |line|
+        next if filtered?(line)
+
+        # Is there a plugin for @tag? If so, use it: Else use the lexer.
+        txt = respond_to?(@tag) ? send(@tag, line) :
+                                  @formatter.format(@lexer.lex(line))
+        yield txt if txt
+      end
+      reset_lexer
+      reset_lang
+    end
+  end
+end

data/lib/colora/plugs/diff.rb

@@ -0,0 +1,67 @@
+module Colora
+  class Lines
+    def diff(line)
+      case line
+      when String
+        case line
+        when /^[-+][-+][-+] [ab]\/(.*)$/
+          reset_lang_by_filename($~[1])
+          format(line)
+        when /^\s*#!/
+          reset_lang_by_source(line)
+          format(line) unless Config.quiet
+        when /^ /
+          format(pad(line), :lang) unless Config.quiet
+        else
+          format(line) unless Config.quiet
+        end
+      else
+        # Initialized text variables
+        txt = ''
+        flags = flags(line)
+        code = line.dig(1,1)||''
+        comment = line.dig(2,1)||''
+        # txt << flags+code
+        case line[0]
+        when '-', '<'
+          txt << format(flags+code+comment)
+          comment = '' # will skip commenting below
+        when '+', '>'
+          case line.dig(1,0)
+          when nil, 't'
+            txt << format(flags+code)
+          when 'd'
+            txt << format(flags, Config.dupplicated_flag)
+            txt << format(code, :lang)
+          when '>'
+            txt << format(flags, Config.inserted_flag)
+            txt << format(code, :lang)
+          when 'e'
+            txt << format(flags, Config.edited_flag)
+            txt << format(code, :lang)
+          else
+            warn "Unknown code type: #{line[0]}"
+          end
+        else
+          warn "Unknown line type: #{line[0]}"
+        end
+        # txt << comment
+        unless comment.empty?
+          case line.dig(2,0)
+          when 't'
+            txt << format(comment, Config.moved_comment)
+          when 'd'
+            txt << format(comment, Config.dupplicated_comment)
+          when '>'
+            txt << format(comment, Config.inserted_comment)
+          when 'e'
+            txt << format(comment, Config.edited_comment)
+          else
+            warn "Unknown comment type: #{line[0]}"
+          end
+        end
+        txt
+      end
+    end
+  end
+end

data/lib/colora/plugs/markdown.rb

@@ -0,0 +1,18 @@
+module Colora
+  class Lines
+    def markdown(line)
+      txt = nil
+      case line
+      when /^```(\w+)$/
+        txt = format(line)
+        reset_lexer($~[1])
+      when /^```$/
+        reset_lexer
+        txt = format(line)
+      else
+        txt = format(line)
+      end
+      txt
+    end
+  end
+end

data/lib/colora.rb

@@ -0,0 +1,32 @@
+module Colora
+  class Error < RuntimeError; end
+  VERSION = '0.1.240114'
+
+  # Colora.run(options)
+  def self.run(options=nil)
+    # Standard libraries:
+    require 'ostruct'
+    # Gems:
+    require 'fuzzystringmatch'
+    require 'paint'
+    require 'rouge'
+    # Colora:
+    require_relative 'colora/configure'
+    require_relative 'colora/data'
+    require_relative 'colora/lines'
+    # Plugs:
+    require_relative 'colora/plugs/diff'
+    require_relative 'colora/plugs/markdown'
+
+    # Configure Colora:
+    Colora.configure(options) if options
+    # By default, run git-diff:
+    Config.git = true if $stdin.tty? && !Config.file
+
+    # Puts Colora::Lines
+    Lines.new.each do |line|
+      line.gsub!("\t", '⇥') if Config.tab
+      puts line
+    end
+  end
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: colora
+version: !ruby/object:Gem::Version
+  version: 0.1.240114
+platform: ruby
+authors:
+- CarlosJHR64
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fuzzy-string-match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: help_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.2.230210
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.2.230210
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.1.1
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.1
+description: |
+  Colorizes terminal outputs.
+
+  Uses `Rouge::Formatters::Terminal256` to theme/color output to the terminal.
+  Color codes git diff.
+email: carlosjhr64@gmail.com
+executables:
+- colora
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/colora
+- lib/colora.rb
+- lib/colora/configure.rb
+- lib/colora/data.rb
+- lib/colora/lines.rb
+- lib/colora/plugs/diff.rb
+- lib/colora/plugs/markdown.rb
+homepage: https://github.com/carlosjhr64/colora
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- 'git: 2.30'
+rubygems_version: 3.5.4
+signing_key: 
+specification_version: 4
+summary: Colorizes terminal outputs.
+test_files: []