ansi_palette 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9666c052c93ea22701018611c9928a1be41b6ae0
+  data.tar.gz: 740dd964c13115bf1df1eb40e816864a9fc39f7e
+SHA512:
+  metadata.gz: 6c3d208981a273bfb96d97fae94983625f55e79c96b031fb7b265bb18e59ed479cff52c1a93bd71b3115086aed387e90098f4d9ef884945e11ceed4458679e7c
+  data.tar.gz: a0cfcef3cbe4624b551778bf3d9602466ea59759454d68847601585b5e93e556bc00044c1852a4ddcf9131144cab3d4abb96c28a75f075f4aadaba7e55845b3d

data/.codeclimate.yml

@@ -0,0 +1,37 @@
+# This is a sample .codeclimate.yml configured for Engine analysis on Code
+# Climate Platform. For an overview of the Code Climate Platform, see here:
+# http://docs.codeclimate.com/article/300-the-codeclimate-platform
+
+# Under the engines key, you can configure which engines will analyze your repo.
+# Each key is an engine name. For each value, you need to specify enabled: true
+# to enable the engine as well as any other engines-specific configuration.
+
+# For more details, see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+# For a list of all available engines, see here:
+# http://docs.codeclimate.com/article/296-engines-available-engines
+
+engines:
+# to turn on an engine, add it here and set enabled to `true`
+# to turn off an engine, set enabled to `false` or remove it
+  rubocop:
+    enabled: true
+
+# Engines can analyze files and report issues on them, but you can separately
+# decide which files will receive ratings based on those issues. This is
+# specified by path patterns under the ratings key.
+
+# For more details see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+ratings:
+  paths:
+  - lib/**
+
+# You can globally exclude files from being analyzed by any engine using the
+# exclude_paths key.
+
+#exclude_paths:
+#- spec/**/*
+#- vendor/**/*

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+sudo: required
+rvm:
+  - 2.1.3
+  - 2.2.3
+  - 2.2.0
+addons:
+  code_climate:
+    repo_token: 016bbfc875ea2906b5ba73b6bfba2e21c0dcd43e497f512d8c29114c4321b962

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ansi_palette.gemspec
+gemspec
+
+gem "minitest-rg"
+gem "minitest-focus"
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 David Begin
+
+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,94 @@
+# AnsiPalette
+
+[![Build Status](https://travis-ci.org/presidentJFK/ansi_palette.svg?branch=master)](https://travis-ci.org/presidentJFK/ansi_palette) [![Test Coverage](https://codeclimate.com/github/presidentJFK/ansi_palette/badges/coverage.svg)](https://codeclimate.com/github/presidentJFK/ansi_palette/coverage) [![Code Climate](https://codeclimate.com/github/presidentJFK/ansi_palette/badges/gpa.svg)](https://codeclimate.com/github/presidentJFK/ansi_palette) [![Dependency Status](https://gemnasium.com/presidentJFK/ansi_palette.svg)](https://gemnasium.com/presidentJFK/ansi_palette)
+
+AnsiPalette is yet another terminal coloring gem.
+I have never been satisfied with the various coloring gems,
+for one reason or another, and never knew the details of how each worked.
+
+Goals of this Gem:
+  * Help me understand more about ANSI escape characters
+  * Create code the makes it easy to understand how ANSI escape charactors are used
+  * Create a simple and usable API for coloring strings
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ansi_palette'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ansi_palette
+
+---
+
+Here is the new implementation I am working on, currently
+still under heavy exploration.
+
+```ruby
+puts "\n\n"
+puts %!puts Red("hello")!
+puts Red("hello")
+puts "\n\n"
+
+header = <<-HEADER
+  A Classy Comment Header
+HEADER
+
+body = <<-BODY
+  Some very interesting comment text.
+  With all these intricate details.
+  Explaining everything you could ever
+  want to know.
+BODY
+
+doc = <<-DOC
+  #{Red(header)}
+    #{Cyan(body)}
+DOC
+
+puts doc
+
+color = Blue("Header")
+puts color
+
+color = Red("Header")
+color.bold = true
+puts color
+
+color = Yellow("Header")
+color.bold = true
+color.blink = true
+puts color
+
+color = Yellow("Header")
+color.bold = true
+color.blink = true
+color.modifier = 3
+puts color
+
+color = Cyan("Header")
+color.bold = true
+color.modifier = 4
+puts color
+
+color = Red("Header")
+color.inverse_colors = true
+color.bold
+puts color
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ansi_palette/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+task :default => "test"
+
+task :test do
+  Dir.glob("test/test*.rb").each do |file|
+    require_relative file
+  end
+end
+
+task :examples do
+  Dir.glob("examples/**.rb").each do |file|
+    require_relative file
+  end
+end

data/ansi_palette.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ansi_palette/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ansi_palette"
+  spec.version       = AnsiPalette::VERSION
+  spec.authors       = ["David Begin"]
+  spec.email         = ["davidmichaelbe@gmail.com"]
+
+  spec.summary       = %q{A gem for helping you color strings with ANSI escape codes.}
+  spec.description   = %q{A gem for helping you color strings with ANSI escape codes.}
+  spec.homepage      = "https://github.com/presidentJFK/ansi_palette"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ansi_palette"
+
+# 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

data/bin/setup

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

data/examples/conversion.rb

@@ -0,0 +1,96 @@
+require_relative "../lib/ansi_palette"
+
+include AnsiPalette
+
+puts "\n\n"
+puts %!puts Red("hello")!
+puts Red("hello")
+puts "\n\n"
+
+header = <<-HEADER
+  A Classy Comment Header
+HEADER
+
+body = <<-BODY
+  Some very interesting comment text.
+  With all these intricate details.
+  Explaining everything you could ever
+  want to know.
+BODY
+
+doc = <<-DOC
+  #{Red(header)}
+    #{Cyan(body)}
+DOC
+
+puts doc
+
+color = Blue("Header")
+puts color
+
+color = Red("Header")
+color.bold = true
+puts color
+
+color = Yellow("Header")
+color.bold = true
+color.blink = true
+puts color
+
+color = Yellow("Header")
+color.bold = true
+color.blink = true
+color.modifier = 3
+puts color
+
+color = Cyan("Header")
+color.bold = true
+color.modifier = 4
+puts color
+
+color = Red("Header")
+color.inverse_colors = true
+color.bold
+puts color
+
+header = Red("WOAH")
+header.blink = true
+
+puts "$$$$$$$$"
+puts "$ #{header} $"
+puts "$$$$$$$$"
+
+class Billboard
+  def initialize(text:, border: "†")
+    @text   = text
+    @border = border
+  end
+
+  def display
+    puts "\n"
+    puts border * length
+    print border + " "
+    print text
+    puts " " + border
+    print border * length
+    puts "\n"
+  end
+
+  private
+
+  attr_reader :text, :border
+
+  def length
+    text.length + 4
+  end
+end
+
+billboad = Billboard.new(text: "DINOSAURS")
+billboad.display
+
+header = Cyan("PINOT NOIR")
+header.blink = true
+header.underline = true
+header.bold = true
+billboad = Billboard.new(text: header, border: "®")
+billboad.display

data/lib/ansi_palette.rb

@@ -0,0 +1,2 @@
+require "ansi_palette/version"
+require_relative "ansi_palette/colored_string"

data/lib/ansi_palette/colored_string.rb

@@ -0,0 +1,143 @@
+require "forwardable"
+require_relative "../ansi_palette"
+
+module AnsiPalette
+  COLOR_HASH = {
+    :black   => { :foreground => 30, :background => 40 },
+    :red     => { :foreground => 31, :background => 41 },
+    :green   => { :foreground => 32, :background => 42 },
+    :yellow  => { :foreground => 33, :background => 43 },
+    :blue    => { :foreground => 34, :background => 44 },
+    :magenta => { :foreground => 35, :background => 45 },
+    :cyan    => { :foreground => 36, :background => 46 },
+    :white   => { :foreground => 37, :background => 47 },
+  }
+
+  EFFECT_HASH = {
+    :reset          => 0,
+    :bold           => 1,
+    :underline      => 4,
+    :blink          => 5,
+    :inverse_colors => 7
+  }
+
+  COLOR_HASH.each_pair.each do |color, color_codes|
+    define_method color.to_s.capitalize do |string|
+      AnsiPalette::ColoredString.new(string: string, color: color)
+    end
+
+    define_method "Bg" + color.to_s.capitalize do |string|
+      AnsiPalette::ColoredString.new(string: string, background: color)
+    end
+
+    const_set("#{color.upcase}_FG", color_codes.fetch(:foreground))
+    const_set("#{color.upcase}_BG", color_codes.fetch(:background))
+  end
+
+  def Bold(str)
+    ColoredString.new(string: str, bold: true).bold
+  end
+
+  START_ESCAPE = "\e[" # "\033["
+  END_ESCAPE   = "m"
+  RESET_COLOR  = 0
+  class ColoredString < String
+    extend ::Forwardable
+
+    def initialize(string:,
+                   color: nil,
+                   foreground: nil,
+                   background: nil,
+                   modifier: nil,
+                   bold: false,
+                   blink: false
+                  )
+
+      @string     = string
+      @color      = color
+      @modifier   = modifier
+      @background = background
+      @foreground = foreground
+      @bold       = bold
+      @blink      = blink
+    end
+
+    EFFECT_HASH.keys.each do |modifier_method|
+      attr_accessor modifier_method
+    end
+
+    attr_accessor :modifier
+
+    def colored_string
+      set_modifiers +
+        set_foreground_color +
+        set_background_color +
+        string +
+        reset_color
+    end
+
+    def blink?; blink; end
+
+    def bold?; bold; end
+
+    alias_method :to_s, :colored_string
+    alias_method :to_str, :to_s
+
+    def_delegators :string, :length
+
+    private
+
+    attr_reader :string, :color, :modifier, :background, :foreground
+
+    def set_modifiers
+      set_modifier +
+        set_blink +
+        set_bold +
+        set_underline +
+        set_blink +
+        set_inverse_colors
+    end
+
+    EFFECT_HASH.each_pair do |modifier, code|
+      define_method "#{modifier}?" do
+        instance_variable_get("@#{modifier}")
+      end
+
+      define_method "set_#{modifier}" do
+        send("#{modifier}?") ? escape_sequence(code.to_s) : ""
+      end
+    end
+
+    def set_modifier
+      !modifier.nil? ? escape_sequence(modifier.to_s) : ""
+    end
+
+    def set_foreground_color
+      set_color(foreground_color, "_FG")
+    end
+
+    def set_background_color
+      set_color(background, "_BG")
+    end
+
+    def set_color(color, color_type)
+      return "" if color.nil?
+
+      escape_sequence(
+        AnsiPalette.const_get(color.to_s.upcase + color_type).to_s
+      )
+    end
+
+    def foreground_color
+      color || foreground
+    end
+
+    def reset_color
+      escape_sequence(RESET_COLOR.to_s)
+    end
+
+    def escape_sequence(content)
+      START_ESCAPE + content + END_ESCAPE
+    end
+  end
+end

data/lib/ansi_palette/version.rb

@@ -0,0 +1,3 @@
+module AnsiPalette
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ansi_palette
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Begin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
+  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'
+description: A gem for helping you color strings with ANSI escape codes.
+email:
+- davidmichaelbe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ansi_palette.gemspec
+- bin/console
+- bin/setup
+- examples/conversion.rb
+- lib/ansi_palette.rb
+- lib/ansi_palette/colored_string.rb
+- lib/ansi_palette/version.rb
+homepage: https://github.com/presidentJFK/ansi_palette
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem for helping you color strings with ANSI escape codes.
+test_files: []
+has_rdoc: