color_me_rad 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f60003287d1971131377f2d97340241dceebfd08f15d9b1ea1136bb12c20f5e6
+  data.tar.gz: f547c73a02f943b9dae8394f7bdedb23117d0d8b88b66edb4291f8c53aa707c9
+SHA512:
+  metadata.gz: 91c890b6bd3bd4cff5ceb25fc56bf0e34cd6345002411de296da6d4faa8514b96f7d8fe74ba1572f856248afdbf3961575edcfeccbc2f0c2c17ad096722aaae4
+  data.tar.gz: 865b0b3b7152abe2c6f885d58dd7f378c881f4efe512c84bd1e0dc0ce86b891c8f1e1ef1aca9a2e51a1e3379cc710e090f40c88c60f70be561c1b391b9025526

data/.cane

@@ -0,0 +1,6 @@
+--color
+--no-doc
+--style-measure 80
+--abc-max 9
+--abc-glob {rakefile,Gemfile,*.gemspec,{lib,spec}/**/*.{rb,rake,example}}
+--style-glob {rakefile,Gemfile,*.gemspec,{lib,spec}/**/*.{rb,rake,example}}

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in color_me_rad.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    color_me_rad (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cane (3.0.0)
+      parallel
+    diff-lcs (1.3)
+    gems (1.1.1)
+      json
+    json (2.2.0)
+    parallel (1.14.0)
+    rake (10.5.0)
+    rake_tasks (5.1.0)
+      rake
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cane
+  color_me_rad!
+  gems
+  rake
+  rake_tasks
+  rspec
+
+BUNDLED WITH
+   1.16.3

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "color_me_rad"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/color_me_rad.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'color_me_rad'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Travis Herrick']
+  spec.email         = ['tthetoad@gmail.com']
+
+  spec.summary       = 'Simple color console output'
+  spec.description   = 'Color console output in a radically simple way'
+  spec.homepage      = 'https://bitbucket.org/toadjamb/gems_color_me_rad'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake_tasks'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'gems'
+end

data/lib/color_me_rad.rb

@@ -0,0 +1,4 @@
+require_relative 'color_me_rad/configuration'
+require_relative 'color_me_rad/color_helper'
+require_relative 'color_me_rad/colorize'
+require_relative 'color_me_rad/core'

data/lib/color_me_rad/color_helper.rb

@@ -0,0 +1,142 @@
+module ColorMeRad
+  module ColorHelper
+    extend self
+
+    def data(data)
+      return hash(data) if data.is_a?(Hash)
+      return array(data) if enumerable?(data)
+      return ar_data(data) if active_record?(data)
+      return ruby_ivars(data) if ivars?(data)
+
+      colorize_data data
+    end
+
+    def key(data, key)
+      color = ColorMeRad.color_for_key(key)
+      add_color data, color
+    end
+
+    private
+
+    def hash(hash)
+      string = key('{', 'Hash')
+      string += map_hash_data(hash)
+      string + key('}', 'Hash')
+    end
+
+    def array(array)
+      string = key('[', 'Array')
+
+      string += array.each.map do |value|
+        data value
+      end.join(key(',', :syntax))
+
+      string + key(']', 'Array')
+    end
+
+    def ruby_ivars(data)
+      as_object(data) do
+        map_ivars data
+      end
+    end
+
+    def ar_data(data)
+      as_object(data) do
+        map_ar_attributes data.attributes
+      end
+    end
+
+    def as_object(data, &block)
+      string = data.to_s
+      strings = string.match(/(#<)(\S+)(:)(\w+)(>)/)
+
+      '%s%s%s%s %s%s' % [
+        key(strings[1], :syntax),
+        key(strings[2], :constant),
+        key(strings[3], :syntax),
+        key(strings[4], 'Integer'),
+        yield,
+        key(strings[5], :syntax),
+      ]
+    end
+
+    def colorize_data(data)
+      color ||= color_for_data_class(data)
+      data  = data.inspect if [String].include?(data.class)
+
+      add_color data, color
+    end
+
+    def add_color(data, color)
+      data = data.inspect if [NilClass, Symbol].include?(data.class)
+      data = data.to_s unless data.is_a?(String)
+
+      ColorMeRad.colorize data, color
+    end
+
+    def colorize(text, foreground = nil, background = nil)
+      ColorMeRad.colorize text, foreground, background
+    end
+
+    def map_hash_data(hash)
+      hash.each.map do |key, value|
+        '%s%s%s' % [
+          data(key),
+          key('=>', :syntax),
+          data(value),
+        ]
+      end.join(key(',', :syntax))
+    end
+
+    def map_ivars(data)
+      data.instance_variables.map do |var|
+        value = data.instance_variable_get(var)
+        format_ivar var, value
+      end.join(' ')
+    end
+
+    def format_ivar(var, value)
+      '%s%s%s' % [
+        key(var.to_s, :ivar),
+        key('=', :syntax),
+        data(value),
+      ]
+    end
+
+    def map_ar_attributes(attrs)
+      attrs.map do |key, value|
+        '%s%s%s' % [
+          key("@#{key}", :ivar),
+          key('=', :syntax),
+          data(value),
+        ]
+      end.join(' ')
+    end
+
+    def color_for_data_class(data)
+      ColorMeRad.color_for_class data.class
+    end
+
+    def ivars?(data)
+      return false unless ColorMeRad.ivars?
+      return false unless data.respond_to?(:instance_variables)
+      if defined?(ActiveRecord) && data.is_a?(ActiveRecord::Base)
+        return false
+      end
+      return false if data.instance_variables.empty?
+      true
+    end
+
+    def active_record?(data)
+      return false unless ColorMeRad.active_record?
+      return false unless defined?(ActiveRecord)
+      data.is_a? ActiveRecord::Base
+    end
+
+    def enumerable?(data)
+      return false unless data.respond_to?(:each)
+      return false if data.respond_to?(:keys)
+      true
+    end
+  end
+end

data/lib/color_me_rad/colorize.rb

@@ -0,0 +1,69 @@
+module ColorMeRad
+  module Colorize
+    extend self
+
+    CODES = {
+      :black   => 0, :light_black   => 60,
+      :red     => 1, :light_red     => 61,
+      :green   => 2, :light_green   => 62,
+      :yellow  => 3, :light_yellow  => 63,
+      :blue    => 4, :light_blue    => 64,
+      :magenta => 5, :light_magenta => 65,
+      :cyan    => 6, :light_cyan    => 66,
+      :white   => 7, :light_white   => 67,
+      :default => 9
+    }
+
+    def colorize(text, foreground, background)
+      return text unless ColorMeRad.enabled?
+
+      text = set_foreground(text, foreground) if foreground
+      text = set_background(text, background) if background
+
+      text
+    end
+
+    def show_samples
+      CODES.keys.permutation(2).each do |background, foreground|
+        message = sample_message(background, foreground, 13)
+        puts colorize(message, foreground, background)
+      end
+    end
+
+    def enable_color=(value)
+      @enable_color = !!value
+    end
+
+    def colorized?
+      return @enable_color if defined?(@enable_color)
+      @enable_color = true
+    end
+
+    private
+
+    def set_foreground(text, color)
+      return text unless CODES[color]
+
+      code = CODES[color] + 30
+      text = text.split("\e[0m").map do |string|
+        "\033[#{code}m#{string}\e[0m"
+      end.join
+    end
+
+    def set_background(text, color)
+      return text unless CODES[color]
+
+      code = CODES[color] + 40
+      text = text.split("\e[0m").map do |string|
+        "\033[#{code}m#{string}\e[0m"
+      end.join
+    end
+
+    def sample_message(background, foreground, pad)
+      '  example of %s on %s  ' % [
+        foreground.to_s.ljust(pad),
+        background.to_s.ljust(pad),
+      ]
+    end
+  end
+end

data/lib/color_me_rad/configuration.rb

@@ -0,0 +1,149 @@
+module ColorMeRad
+  class Configuration
+    attr_reader :classes, :keys
+
+    class << self
+      def current_config
+        @configuration ||= new
+      end
+    end
+
+    def initialize
+      self.enabled       = true
+      self.ivars         = false
+      self.active_record = false
+
+      @keys = {
+        :constant => :yellow,
+        :ivar     => :light_green,
+        :syntax   => :light_black,
+      }
+
+      @classes = {
+        'Fixnum'        => :red,
+        "#{Integer}"    => :red,
+        "#{String}"     => :black,
+        'Date'          => :light_magenta,
+        'DateTime'      => :light_cyan,
+        "#{Time}"       => :light_cyan,
+        'BigDecimal'    => :red,
+        "#{TrueClass}"  => :cyan,
+        "#{FalseClass}" => :cyan,
+        "#{NilClass}"   => :yellow,
+        "#{Symbol}"     => :light_green,
+        "#{Hash}"       => :yellow,
+        "#{Array}"      => :yellow,
+        "#{Float}"      => :red,
+        "#{Class}"      => :yellow,
+        "#{Module}"     => :yellow,
+      }
+    end
+
+    def enabled=(value)
+      @enabled = !!value
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    def ivars=(value)
+      @ivars = !!value
+    end
+
+    def ivars?
+      @ivars
+    end
+
+    def active_record=(value)
+      @active_record = !!value
+    end
+
+    def active_record?
+      @active_record
+    end
+
+    def color_for_class(klass)
+      color_for_key klass.to_s
+    end
+
+    def color_for_key(key)
+      color = @classes[key] || @keys[key]
+      color ||= key if Colorize::CODES[key]
+      color
+    end
+
+    def set_colors(keys)
+      validate_hash keys
+      keys.each do |key, color|
+        set_color key, color
+      end
+    end
+
+    def set_color(key, color)
+      validate_key key, color
+      @keys.merge! key => color
+    end
+
+    def set_class_colors(keys)
+      validate_hash keys
+      keys.each do |key, color|
+        set_class_color key, color
+      end
+    end
+
+    def set_class_color(key, color)
+      validate_class_key key, color
+      @classes.merge! key => color
+    end
+
+    private
+
+    def validate_hash(value)
+      return if value.is_a?(Hash)
+      errors = []
+      errors << "Not a hash: #{value.inspect}"
+      show_errors errors
+    end
+
+    def validate_key(key, color)
+      errors = []
+
+      validate_color color, errors
+      validate_unique_key key, errors
+
+      show_errors errors
+    end
+
+    def validate_class_key(key, color)
+      errors = []
+
+      validate_color color, errors
+      validate_used_key key, errors
+
+      show_errors errors
+    end
+
+    def validate_color(color, errors)
+      return if ColorMeRad::Colorize::CODES.keys.include?(color)
+      errors << "#{color} is not a valid color"
+    end
+
+    def validate_unique_key(key, errors)
+      return unless @classes[key]
+      errors << '%s is used in class settings: use #set_class_color instead' % [
+        key.inspect,
+      ]
+    end
+
+    def validate_used_key(key, errors)
+      return if @classes.keys.include?(key)
+      errors << "key is not expected in class settings: #{key.inspect}"
+    end
+
+    def show_errors(errors)
+      return if errors.empty?
+      raise "#{ColorMeRad::Configuration}: " + errors.join('. ') + '.'
+    end
+  end
+end

data/lib/color_me_rad/core.rb

@@ -0,0 +1,76 @@
+module ColorMeRad
+  module Core
+    # configuration methods
+
+    def configure(&block)
+      yield Configuration.current_config
+    end
+
+    def enabled=(value)
+      configuration.enabled = value
+    end
+
+    def enable!
+      configuration.enabled = true
+    end
+
+    def disable!
+      configuration.enabled = false
+    end
+
+    def enabled?
+      configuration.enabled?
+    end
+
+    def ivars?
+      configuration.ivars?
+    end
+
+    def active_record?
+      configuration.active_record?
+    end
+
+
+    # examples and samples
+
+    def show_color_samples
+      Colorize.show_samples
+    end
+
+
+    # colorization methods
+
+    # TODO: test (officially)
+    def colorize(data, foreground = nil, background = nil)
+      Colorize.colorize data, foreground, background
+    end
+
+    # TODO: test (officially)
+    def data(data)
+      ColorHelper.data data
+    end
+
+    # TODO: test (officially)
+    def key(data, key)
+      ColorHelper.key data, key
+    end
+
+    # TODO: test
+    def color_for_key(key)
+      configuration.color_for_key key
+    end
+
+    # TODO: test
+    def color_for_class(klass)
+      configuration.color_for_class klass
+    end
+
+    private
+
+    def configuration
+      Configuration.current_config
+    end
+  end
+
+  extend Core
+end

data/rakefile

@@ -0,0 +1,18 @@
+$VERBOSE = true
+
+require 'rake_tasks'
+
+require 'io/console'
+require 'rake_tasks/tasks/release'
+
+require 'rake_tasks/tasks/spec'
+
+$VERBOSE = nil
+require 'cane'
+require 'rake_tasks/tasks/cane'
+$VERBOSE = true
+
+task :default => [
+  :cane,
+  :specs,
+]

data/readme.md

@@ -0,0 +1,146 @@
+ColorMeRad
+==========
+
+Standardize the way you color your data and messages.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'color_me_rad'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install color_me_rad
+
+
+Usage
+-----
+
+### Basic API
+
+Print a hash that has keys and values colored according to configuration:
+
+    > puts ColorMeRad.data({:foo => 'bar'}
+
+Print a string that is colored using a custom setting
+(must be set using one of the configuration methods below):
+
+    > puts ColorMeRad.key('foo', :title)
+
+Return the color for a given class:
+
+    > ColorMeRad.color_for_class(String) #=> :black
+
+Return the color for a given key:
+
+    > ColorMeRad.color_for_key('String') #=> :black
+
+`key` and `color_for_key` will look in both class settings
+and custom settings for a color,
+so give it any key that has a color associated with it
+and it will give you the color back.
+
+
+### Configuration
+
+#### Enabling/Disabling
+
+```
+# via configuration
+ColorMeRad.configure do |config|
+  config.enabled = true  #=> turn on all coloring
+  config.enabled = false #=> turn off all coloring
+end
+
+
+# via module api (useful for disabling during testing)
+
+ColorMeRad.enabled = true  #=> turn on all coloring
+ColorMeRad.enabled? #=> true
+
+ColorMeRad.enabled = false #=> turn off all coloring
+ColorMeRad.enabled? #=> false
+
+```
+
+
+#### Colors
+
+If you intend to override color settings
+or add your own, it is intended to happen via the configure block:
+
+
+##### Override Existing Colors (class names)
+
+A number of Ruby classes have colors set initially.
+If you want to override these,
+it can be done using `set_class_color` or `set_class_colors`.
+
+Please note that if you attempt to set one of these keys
+using the `set_color` or `set_colors` api,
+an error will be raised.
+
+
+```
+ColorMeRad.configure do |config|
+  config.set_class_color 'Integer', :green
+  config.set_class_color 'String', :blue
+
+  config.set_class_colors({
+    'TrueClass'  => :light_magenta,
+    'FalseClass' => :light_cyan,
+  })
+end
+```
+
+
+##### Add new color settings
+
+Please note that if you attempt to set one of the class keys
+using the `set_class_color` or `set_class_colors` api,
+an error will be raised.
+
+
+```
+ColorMeRad.configure do |config|
+  config.set_color :title, :green
+  config.set_color :author, :blue
+
+  config.set_colors({
+    :error => :light_red,
+    :warn  => :red,
+  })
+end
+```
+
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt
+that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`,
+which will create a git tag for the version,
+push git commits and tags,
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on Bitbucket
+at https://bitbucket.org/toadjamb/gems_color_me_rad.

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: color_me_rad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Travis Herrick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake_tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gems
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Color console output in a radically simple way
+email:
+- tthetoad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cane"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- bin/console
+- bin/setup
+- color_me_rad.gemspec
+- lib/color_me_rad.rb
+- lib/color_me_rad/color_helper.rb
+- lib/color_me_rad/colorize.rb
+- lib/color_me_rad/configuration.rb
+- lib/color_me_rad/core.rb
+- rakefile
+- readme.md
+homepage: https://bitbucket.org/toadjamb/gems_color_me_rad
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Simple color console output
+test_files: []