crayon 0.0.1 → 0.0.5

data/.document

@@ -1,5 +1,4 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
+README.md
 LICENSE
+lib/**/*.rb
+spec/**/*.rb

data/.gitignore

@@ -1,10 +0,0 @@
-# VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-diff
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem "yard"
+gem "rspec"

data/README.md

@@ -0,0 +1,69 @@
+# crayon
+
+### current version : 0.0.3
+
+[http://github.com/mikowitz/crayon][github]
+
+## Description
+
+A simple, flexible gem that provides an open-ended API to print colored and styled output to the terminal.
+
+## Installation
+
+Install the gemcutter gem
+
+    ~$ gem install gemcutter
+
+Add gemcutter.org to your gem remote sources
+
+    ~$ gem tumble
+
+Download and install this gem
+
+    ~$ gem install crayon
+
+## Usage examples
+
+To include this gem in a project
+
+    require 'crayon'
+
+The following are all methods that `Crayon` understands, and should give you an idea of what is possible.
+
+    Crayon.blue("this will be printed as blue text")
+    Crayon.on_red("this will be printed on a red background")
+    Crayon.bold("this will be bold")
+    Crayon.underline_blue_on_yellow("this will be underlined blue text on a yellow background")
+
+`Crayon` also provides intermediary methods `puts` and `print` which determine whether `Crayon` adds a newline to the end of the text being displayed.
+By default, a newline is added.
+
+    Crayon.puts.blue("this is on a line by itself.")
+    Crayon.print.blue("the next line will be printed right next to this")
+    Crayon.puts.green("this will on the second line of output, but will create a newline.")
+
+`puts` and `print` set an internal, persistent variable, so a specified newline presence or absence will last until `puts` or `print` is invoked again.
+
+    Crayon.print.blue("on the first line")
+    Crayon.green("also on the first line")
+    Crayon.red("also on the first line")
+    Crayon.puts.cyan("Also on the first line, but with a trailing newline")
+    Crayon.blue("On the second line by itself.")
+
+## Flexibility
+
+The order of elements in the method name is unimportant. For example
+
+    Color.bold_underline_blue_on_yellow("sample text")
+
+will look the same as
+
+    Color.on_yellow_bold_blue_underline("sample text")
+
+Check out `test/proof.rb` and `~$ rake proof` if you don't believe me.
+
+## Copyright
+
+Copyright (c) 2010 Michael Berkowitz. See LICENSE for details.
+
+[github]: http://github.com/mikowitz/crayon "Crayon repository"

data/Rakefile

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'rake'
 
 begin
@@ -10,8 +9,6 @@ begin
     gem.email = "michael.berkowitz@gmail.com"
     gem.homepage = "http://github.com/mikowitz/crayon"
     gem.authors = ["Michael Berkowitz"]
-    gem.add_development_dependency "tinytest", ">= 0"
-    gem.add_development_dependency "yard", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -19,58 +16,31 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << "lib" << "spec"
+  spec.spec_files = FileList["spec/**/*_spec.rb"]
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << "lib" << "spec"
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rcov = true
 end
 
-task :test => :check_dependencies
-
-begin
-  require 'reek/adapters/rake_task'
-  Reek::RakeTask.new do |t|
-    t.fail_on_error = true
-    t.verbose = false
-    t.source_files = 'lib/**/*.rb'
-  end
-rescue LoadError
-  task :reek do
-    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
-  end
-end
+task :spec => :check_dependencies
+task :default => :spec
 
-begin
-  require 'roodi'
-  require 'roodi_task'
-  RoodiTask.new do |t|
-    t.verbose = false
-  end
-rescue LoadError
-  task :roodi do
-    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
-  end
+desc "'Proof is the bottom line for everyone' -- Paul Simon"
+task :proof do
+  system "ruby test/proof.rb"
 end
 
-task :default => :test
-
 begin
   require 'yard'
-  YARD::Rake::YardocTask.new
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ['--no-private', '-mmarkdown']
+  end
 rescue LoadError
   task :yardoc do
     abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.5

data/lib/crayon.rb

@@ -1,75 +1,108 @@
 module Crayon
   extend self
 
-  @@newline = true
- 
-  COLORS = {
-    "black" => 0,
-    "red" => 1,
-    "green" => 2,
-    "yellow" => 3,
-    "blue" => 4,
-    "magenta" => 5,
-    "cyan" => 6,
-    "white" => 7
-  }
-
-  FORMATS = {
-    "bold" => 1,
-    "underline" => 4
-  }
+  class << self
+    # @private
+    attr_accessor :foreground, :background, :formatting, :method_name, :color, :newline
+  end
 
+  # @private
+  COLORS = { "black" => 0, "red" => 1, "green" => 2, "yellow" => 3, "blue" => 4, "magenta" => 5, "cyan" => 6, "white" => 7 }
+  # @private
+  FORMATS = { "bold" => 1, "underline" => 4 }
+  # @private
   TERMINATION_STRING = "\e[0m"
 
-  def newline?; @@newline; end
+  # @private
+  def newline?; @newline.nil? ? true : @newline; end
+  # @private
   def io; $stderr; end
 
-  def self.print; @@newline = false; return Crayon; end
+  def self.print; @newline = false; return Crayon; end
 
-  def self.puts; @@newline = true; return Crayon; end
+  def self.puts; @newline = true; return Crayon; end
 
   def method_missing(method_name, string)
-    io.print prepare_string(string, *parse_method_name(method_name))
-    io.flush
+    @method_name = method_name
+    parse_method_name
+    io.print prepare_string(string)
+    nullify_variables
+  end
+
+  ##
+  # Converts a method name into color and formatting parameters
+  # @example
+  #   Crayon.parse_method_name(:bold_red_on_green)  #=>  "['red', 'green', ['bold']]"
+  # @private
+  def parse_method_name
+    @method_name = @method_name.to_s.split("_")
+    @background = parse_background
+    @foreground = parse_foreground
+    @formatting = parse_formatting
+  end
+
+  # @private
+  def parse_background
+    _idx = @method_name.index("on")
+    if _idx
+      @method_name.delete("on")
+      return @method_name.delete_at(_idx)
+    end
   end
 
-  def prepare_string(string, foreground=nil, background=nil, formatting=[])
-    [
-      prepare_foreground_color(foreground),
-      prepare_background_color(background),
-      prepare_formatting(*formatting),
+  # @private
+  def parse_foreground
+    @method_name.find {|color| COLORS.keys.include?(color) }
+  end
+
+  # @private
+  def parse_formatting
+    @method_name.select {|format| FORMATS.keys.include?(format) }
+  end
+
+  ##
+  # Builds output string with color escape characters.
+  # @example
+  #   Crayon.prepare_string('hello', 'red', 'blue', ['underline'])  #=>  "\e[31m\e[44m\e[4mhello\e[0m"
+  # @private
+  def prepare_string(string) #, foreground=nil, background=nil, formatting=[])
+    [ prepare_foreground_color,
+      prepare_background_color,
+      prepare_formatting,
       string,
-      TERMINATION_STRING,
+      (TERMINATION_STRING if @foreground || @background || !@formatting.empty?),
       (newline? ? "\n" : "")
     ].join("")
   end
 
-  def parse_method_name(method_name)
-    _name = method_name.to_s.split("_")
-    if _idx = _name.index("on")
-      _name.delete("on")
-      _background_color = _name.delete_at(_idx)
-    end
-    _foreground_color = _name.find {|color| COLORS.keys.include?(color) }
-    _formatting = _name.select{|format| FORMATS.keys.include?(format) }
-    [_foreground_color, _background_color, _formatting]
+  # @private
+  def prepare_foreground_color
+    @color = @foreground
+    handle_color(3)
   end
 
-  def prepare_foreground_color(color=nil)
-    handle_color(3, color)
+  # @private
+  def prepare_background_color
+    @color = @background
+    handle_color(4)
   end
 
-  def prepare_background_color(color=nil)
-    handle_color(4, color)
+  # @private
+  def prepare_formatting
+    return "" if @formatting.empty?
+    @formatting.map{|format| "\e[#{FORMATS[format]}m"}.join("")
   end
 
-  def prepare_formatting(*formats)
-    return "" if formats.empty?
-    formats.map{|f| "\e[#{FORMATS[f]}m"}.join("")
+  # @private
+  def handle_color(lead)
+    return "" unless @color
+    "\e[#{lead}#{COLORS[@color]}m"
   end
 
-  def handle_color(lead, color=nil)
-    return "" unless color
-    "\e[#{lead}#{COLORS[color]}m"
+  # @private
+  def nullify_variables
+    @foreground, @background, @formatting = nil, nil, []
+    @method_name, @color = nil, nil
+    io.flush
   end
 end

data/spec/crayon_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + "/helper")
+
+def test_parse_method_name(input, *output)
+  describe "for input :#{input}" do
+    before do
+      Crayon.method_name = input
+      Crayon.parse_method_name
+      @fore, @back, @form = output
+    end
+    after { [:foreground, :background, :formatting].each {|method| Crayon.send(:"#{method}=", nil) } }
+    it "should return #{@fore.inspect} for foreground" do
+      Crayon.foreground.should == @fore
+    end
+    it "should return #{@back.inspect} for background" do
+      Crayon.background.should == @back
+    end
+    it "should return #{@form.inspect} for formatting" do
+      Crayon.formatting.should == @form
+    end
+  end
+end
+
+def test_prepare_string(expected_output, *args)
+  it "should return correctly for #{args.inspect}" do
+    Crayon.foreground = args.fetch(1) { nil }
+    Crayon.background = args.fetch(2) { nil }
+    Crayon.formatting = args.fetch(3) { []  }
+    Crayon.prepare_string(args.first).should == expected_output
+  end
+end
+
+describe "Crayon" do
+  it "should, by default, add line breaks" do
+    Crayon.newline?.should be
+  end
+  describe "after a print command" do
+    before { Crayon.print }
+    it "should not add line breaks" do
+      Crayon.newline?.should_not be
+    end
+  end
+  describe "after a puts command" do
+    before { Crayon.puts }
+    it "should add line breaks" do
+      Crayon.newline?.should be
+    end
+  end
+  describe "method_missing" do
+    describe "should call :prepare string" do
+      before { Crayon.should_receive(:prepare_string).with("hello") }
+      it "when Crayon.red is called" do
+        Crayon.red("hello")
+      end
+    end
+    describe "should unset instance variables after being called" do
+      before { Crayon.bold_red_on_green("hello") }
+      it "should unset foreground" do
+        Crayon.foreground.should be_nil
+      end
+      it "should unset background" do
+        Crayon.background.should be_nil
+      end
+      it "should unset formatting" do
+        Crayon.formatting.should be_empty
+      end
+      it "should unset method_name" do
+        Crayon.method_name.should be_nil
+      end
+    end
+  end
+  describe "parse_method_name" do
+    test_parse_method_name(:red, "red", nil, [])
+    test_parse_method_name(:on_red, nil, "red", [])
+    test_parse_method_name(:bold, nil, nil, ["bold"])
+
+    test_parse_method_name(:blue_on_green, "blue", "green", [])
+    test_parse_method_name(:bold_cyan_on_magenta, "cyan", "magenta", ["bold"])
+
+    test_parse_method_name(:red_green, "red", nil, [])
+    test_parse_method_name(:red_bold_underline, "red", nil, ["bold", "underline"])
+    test_parse_method_name(:underline_on_green_bold, nil, "green", ["underline", "bold"])
+  end
+
+  describe "prepare_string" do
+    describe "with no line break" do
+      before { Crayon.print }
+      test_prepare_string("hello", "hello") 
+      test_prepare_string("\e[31mhello\e[0m", "hello", "red", nil)
+      test_prepare_string("\e[33m\e[47mhello\e[0m", "hello", "yellow", "white")
+      test_prepare_string("\e[4m\e[1mhello\e[0m", "hello", nil, nil, ["underline", "bold"])
+    end
+
+    describe "with a line break" do
+      before { Crayon.puts }
+      test_prepare_string("hello\n", "hello") 
+      test_prepare_string("\e[31mhello\e[0m\n", "hello", "red", nil)
+      test_prepare_string("\e[33m\e[47mhello\e[0m\n", "hello", "yellow", "white")
+      test_prepare_string("\e[4m\e[1mhello\e[0m\n", "hello", nil, nil, ["underline", "bold"])
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'crayon'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+-fs
+--color

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Michael Berkowitz
@@ -14,33 +14,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-15 00:00:00 -04:00
+date: 2010-04-21 00:00:00 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: tinytest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
+dependencies: []
+
 description: A simple, flexible gem that provides an open-ended API to print colored and styled output to the terminal.
 email: michael.berkowitz@gmail.com
 executables: []
@@ -49,17 +26,19 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
+- Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/crayon.rb
-- test/helper.rb
-- test/test_crayon.rb
+- spec/crayon_spec.rb
+- spec/helper.rb
+- spec/spec.opts
 has_rdoc: true
 homepage: http://github.com/mikowitz/crayon
 licenses: []
@@ -91,5 +70,5 @@ signing_key:
 specification_version: 3
 summary: a new version of 'color' with a less common name.
 test_files: 
-- test/helper.rb
-- test/test_crayon.rb
+- spec/crayon_spec.rb
+- spec/helper.rb

data/README.rdoc

@@ -1,45 +0,0 @@
-= crayon
-
-=== current version : 0.0.2
-
-http://github.com/mikowitz/crayon
-
-== Description
-
-A simple, flexible gem that provides an open-ended API to print colored and styled output to the terminal.
-
-== Installation
-
-Install the gemcutter gem
-  ~$ gem install gemcutter
-Add gemcutter.org to your gem remote sources
-  ~$ gem tumble
-Download and install this gem
-  ~$ gem install crayon
-
-== Usage examples
-
-To include this gem in a project
-  require 'crayon'
-
-The following are all methods that <code>Crayon</code> understands, and should give you an idea of what is possible.
-
-  Crayon.blue("this will be printed as blue text")
-  Crayon.on_red("this will be printed on a red background")
-  Crayon.bold("this will be bold")
-  Crayon.underline_blue_on_yellow("this will be underlined blue text on a yellow background")
-
-The order of elements in the method name is also unimportant. For example
-
-  Color.bold_underline_blue_on_yellow("sample text")
-
-will look the same as
-
-  Color.on_yellow_bold_blue_underline("sample text")
-
-Check out <code>test/proof.rb"</code> and <code>`rake proof`</code> if you don't believe me.
-
-== Copyright
-
-Copyright (c) 2010 Michael Berkowitz. See LICENSE for details.
-

data/test/helper.rb

@@ -1,7 +0,0 @@
-require 'rubygems'
-require 'tinytest'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'crayon'
-

data/test/test_crayon.rb

@@ -1,27 +0,0 @@
-require 'helper'
-
-include TinyTest
-
-is { Crayon.newline? } # by default?
-
-is {
-  Crayon.print
-  not Crayon.newline?
-}
-
-is {
-  Crayon.puts
-  Crayon.newline?
-}
-
-# Crayon.parse_method_name
-does { Crayon.parse_method_name(:red) == ["red", nil, []] }
-does { Crayon.parse_method_name(:on_red) == [nil, "red", []] }
-does { Crayon.parse_method_name(:bold) == [nil, nil, ["bold"]] }
-
-does { Crayon.parse_method_name(:blue_on_green) == ["blue", "green", []] }
-does { Crayon.parse_method_name(:bold_cyan_on_magenta) == ["cyan", "magenta", ["bold"]] }
-
-does { Crayon.parse_method_name(:red_green) == ["red", nil, []] }
-does { Crayon.parse_method_name(:red_bold_underline) == ["red", nil, ["bold", "underline"]] }
-does { Crayon.parse_method_name(:underline_on_green_bold) == [nil, "green", ["underline", "bold"]] }