colorator 0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a17df7703b85003ff47ffcf8e009238af1182b4
+  data.tar.gz: 30aa293378acee4845b2c915fc06058be7f020bd
+SHA512:
+  metadata.gz: b865afe608e588b37c68b6b949a64e5b96b3f45dd43cd169a623d4e2b0a1477b7b72c5206979411ad240902d35b0ea64497d31ef8fea3f377fb68931cceef7cf
+  data.tar.gz: 7a223fd8b7747eb86cb310c42ee1c50a09e3c72b74b66935dab90e690767c09e197b029c0bdf22174b2409fa54c7d78cb30145e3d2391d2f0640ea9fd30fea3b

data/Gemfile

@@ -1,2 +1,11 @@
 source "https://rubygems.org"
 gemspec
+
+gem "rake"
+group :development do
+  gem "rspec-helpers", :require => false
+  gem "luna-rspec-formatters", :require => false
+  gem "pry", :require => false unless ENV[
+    "CI"
+  ]
+end

data/History.markdown

@@ -0,0 +1,21 @@
+## HEAD
+
+### Major enhancements
+
+- Merge Simple::ANSI and Colorator. (#7)
+
+### Minor Enhancements
+
+- Delete unnecessary `Symbol#to_sym` (#2)
+- Change argument name of `Enumerator#each` for better code legibility (#3)
+
+### Bug Fixes
+
+### Development Fixes
+
+- Convert to new RSpec expectation syntax (#1)
+- Fix `String#blue` result in README (#4)
+
+## 0.1 / 2013-04-13
+
+Birthday!

data/README.markdown

@@ -2,27 +2,38 @@
 
 Colorize your text for the terminal
 
+[![Build Status](https://travis-ci.org/octopress/colorator.png?branch=master)](https://travis-ci.org/octopress/colorator)
+
 ## Example
 
 ```ruby
 "this string".red
 # => \e[31mthis string\e[0m
 "my string".blue
-# => \e[34mthis string\e[0m
+# => \e[34mmy string\e[0m
 # etc...
 ```
 
 ## Supported Colors
 
-- black
-- red
-- green
-- yellow
-- blue
-- magenta
-- cyan
-- white
-- bold
+- `red`
+- `black`
+- `green`
+- `yellow`
+- `magenta`
+- `white`
+- `blue`
+- `cyan`
+- `bold`
+
+## Other supported Ansi methods
+
+- `clear_line`
+- `has_ansi?`, `has_color?`
+- `strip_ansi`, `strip_color`
+- `reset_ansi`, `reset_color`
+- `clear_screen`
+- `ansi_jump`
 
 ## Why
 

data/Rakefile

@@ -1,146 +1,6 @@
-require 'rubygems'
-require 'rake'
-require 'date'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-#############################################################################
-#
-# Helper functions
-#
-#############################################################################
-
-def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
-def gemspec_file
-  "#{name}.gemspec"
-end
-
-def gem_file
-  "#{name}-#{version}.gem"
-end
-
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
-#############################################################################
-#
-# Standard tasks
-#
-#############################################################################
-
-task :default => :spec
-
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-desc "Generate RCov test coverage and open in your browser"
-task :coverage do
-  require 'rcov'
-  sh "rm -fr coverage"
-  sh "rcov test/test_*.rb"
-  sh "open coverage/index.html"
-end
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "#{name} #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
-end
-
-#############################################################################
-#
-# Custom tasks (add your own tasks here)
-#
-#############################################################################
-
-
-
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
-desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
-task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    exit!
-  end
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
-  sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{name}-#{version}.gem"
-end
-
-desc "Build #{gem_file} into the pkg directory"
-task :build => :gemspec do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-desc "Generate #{gemspec_file}"
-task :gemspec => :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
-
-desc "Validate #{gemspec_file}"
-task :validate do
-  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
-  unless libfiles.empty?
-    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
-    exit!
-  end
-  unless Dir['VERSION*'].empty?
-    puts "A `VERSION` file at root level violates Gem best practices."
-    exit!
-  end
-end
+task :default => :spec

data/colorator.gemspec

@@ -1,66 +1,23 @@
-## This is the rakegem gemspec template. Make sure you read and understand
-## all of the comments. Some sections require modification, and others can
-## be deleted if you don't need them. Once you understand the contents of
-## this file, feel free to delete any comments that begin with two hash marks.
-## You can find comprehensive Gem::Specification documentation, at
-## http://docs.rubygems.org/read/chapter/20
-Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.rubygems_version = '1.3.5'
+# coding: utf-8
 
-  ## Leave these as is they will be modified for you by the rake gemspec task.
-  ## If your rubyforge_project name is different, then edit it and comment out
-  ## the sub! line in the Rakefile
-  s.name              = 'colorator'
-  s.version           = '0.1'
-  s.date              = '2013-04-13'
-  s.license           = 'MIT'
+require File.expand_path('lib/colorator.rb', __dir__)
 
-  ## Make sure your summary is short. The description may be as long
-  ## as you like.
-  s.summary     = "String core extensions for terminal coloring."
-  s.description = "Colorize your text in the terminal."
+Gem::Specification.new do |spec|
+  spec.name        = "colorator"
+  spec.summary     = "Colorize your text in the terminal."
+  spec.version     = Colorator::VERSION
+  spec.authors     = ["Parker Moore", "Brandon Mathis"]
+  spec.email       = ["parkrmoore@gmail.com", "brandon@imathis.com"]
+  spec.homepage    = "https://github.com/octopress/colorator"
+  spec.licenses    = ["MIT"]
 
-  ## List the primary authors. If there are a bunch of authors, it's probably
-  ## better to set the email to an email list or something. If you don't have
-  ## a custom homepage, consider using your GitHub URL or the like.
-  s.authors  = ["Parker Moore", "Brandon Mathis"]
-  s.email    = ["parkrmoore@gmail.com", "brandon@imathis.com"]
-  s.homepage = 'https://github.com/octopress/colorator'
+  all                = `git ls-files -z`.split("\x0").reject { |f| f.start_with?(".") }
+  spec.files         = all.select { |f| File.basename(f) == f || f =~ %r{^(bin|lib)/} }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
-  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
-  s.require_paths = %w[lib]
+  spec.extra_rdoc_files = ["README.markdown", "LICENSE"]
+  spec.rdoc_options     = ["--charset=UTF-8"]
 
-  ## Specify any RDoc options here. You'll want to add your README and
-  ## LICENSE files to the extra_rdoc_files list.
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README.markdown LICENSE]
-
-  ## List your development dependencies here. Development dependencies are
-  ## those that are only needed during development
-  s.add_development_dependency('rake', '~> 10.0')
-  s.add_development_dependency('rspec', '~> 2.13.0')
-
-  ## Leave this section as-is. It will be automatically generated from the
-  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
-  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
-  # = MANIFEST =
-  s.files = %w[
-    Gemfile
-    LICENSE
-    README.markdown
-    Rakefile
-    colorator.gemspec
-    lib/colorator.rb
-    lib/colorator/core_ext.rb
-    spec/colorator/core_ext_spec.rb
-    spec/spec_helper.rb
-  ]
-  # = MANIFEST =
-
-  ## Test files will be grabbed from the file list. Make sure the path glob
-  ## matches what you actually use.
-  s.test_files = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
+  spec.add_development_dependency "rspec", "~> 3.1"
 end

data/lib/colorator.rb

@@ -1,7 +1,12 @@
 $:.unshift File.dirname(__FILE__)
 
 module Colorator
-  VERSION = "0.1"
+  module_function
+  VERSION = "1.0.0"
+
+  # --------------------------------------------------------------------------
+
+  ANSI_MATCHR = /\x1b.*?[jkmsuABGKH]/
   ANSI_COLORS = {
     :black   => 30,
     :red     => 31,
@@ -13,6 +18,94 @@ module Colorator
     :white   => 37,
     :bold    => 1
   }
+
+  # --------------------------------------------------------------------------
+  # Allows you to check if a string currently has ansi.
+  # --------------------------------------------------------------------------
+
+  def has_ansi?(str)
+    str.match(ANSI_MATCHR).is_a?(
+      MatchData
+    )
+  end
+
+  # --------------------------------------------------------------------------
+  # Jump the cursor, moving it up and then back down to it's spot, allowing
+  # you to do fancy things like multiple output (downloads) the way that Docker
+  # does them in an async way without breaking term.
+  # --------------------------------------------------------------------------
+
+  def ansi_jump(str, num)
+    "\x1b[#{num}A#{clear_line(str)}\x1b[#{
+      num
+    }B"
+  end
+
+  # --------------------------------------------------------------------------
+
+  def reset_ansi(str = "")
+    "\x1b[0m#{
+      str
+    }"
+  end
+
+  # --------------------------------------------------------------------------
+
+  def clear_line(str = "")
+    "\x1b[2K\r#{
+      str
+    }"
+  end
+
+  # --------------------------------------------------------------------------
+  # Strip ANSI from the current string, making it just a normal string.
+  # --------------------------------------------------------------------------
+
+  def strip_ansi(str)
+    str.gsub(
+      ANSI_MATCHR, ""
+    )
+  end
+
+  # --------------------------------------------------------------------------
+  # Clear the screen's current view, so the user gets a clean output.
+  # --------------------------------------------------------------------------
+
+  def clear_screen(str = "")
+    "\x1b[H\x1b[2J#{
+      str
+    }"
+  end
+
+  # --------------------------------------------------------------------------
+
+  def colorize(str = "", color)
+    "\x1b[#{color}m#{str}\x1b[0m"
+  end
+
+  # --------------------------------------------------------------------------
+
+  Colorator::ANSI_COLORS.each do |color, code|
+    define_method color do |str|
+      colorize(
+        str, code
+      )
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  class << self
+    alias reset_color reset_ansi
+    alias strip_color strip_ansi
+    alias has_color? has_ansi?
+  end
+
+  # --------------------------------------------------------------------------
+
+  CORE_METHODS = (
+    public_methods - Object.methods
+  )
 end
 
 require "colorator/core_ext"

data/lib/colorator/core_ext.rb

@@ -1,10 +1,9 @@
 class String
-  # colorization
-  def colorize(color_code)
-    "\e[#{color_code}m#{self}\e[0m"
+  Colorator::CORE_METHODS.each do |method|
+    define_method method do |*args|
+      Colorator.public_send(method,
+        self, *args
+      )
+    end
   end
-
-  Colorator::ANSI_COLORS.each do |key, value|
-    define_method(key) { colorize(value) }
-  end
-end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: colorator
 version: !ruby/object:Gem::Version
-  version: '0.1'
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Parker Moore
@@ -10,41 +9,23 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-13 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
-description: Colorize your text in the terminal.
+        version: '3.1'
+description: 
 email:
 - parkrmoore@gmail.com
 - brandon@imathis.com
@@ -55,39 +36,36 @@ extra_rdoc_files:
 - LICENSE
 files:
 - Gemfile
+- History.markdown
 - LICENSE
 - README.markdown
 - Rakefile
 - colorator.gemspec
 - lib/colorator.rb
 - lib/colorator/core_ext.rb
-- spec/colorator/core_ext_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/octopress/colorator
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 2
-summary: String core extensions for terminal coloring.
-test_files:
-- spec/colorator/core_ext_spec.rb
+specification_version: 4
+summary: Colorize your text in the terminal.
+test_files: []

data/spec/colorator/core_ext_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-
-describe String do
-  let(:string) { "i am a test string, y'know?" }
-
-  it "contains all the methods from Colorator::ANSI_COLORS" do
-    Colorator::ANSI_COLORS.keys.each do |color|
-      string.methods.should include(color)
-    end
-  end
-
-  it "colors the text properly" do
-    Colorator::ANSI_COLORS.each do |color, code|
-      string.send(color.to_sym).should include(code.to_s)
-      string.send(color.to_sym).should eq("\e[#{code}m#{string}\e[0m")
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
-
-require 'rspec/autorun'
-require 'colorator'
-
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.order = 'random'
-end