crayon 1.0.0 → 1.0.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.0.1 : 04/21/10
+
+* Adds deprecation warnings for `puts` and `print`
+
 ### 1.0.0 : 04/21/10
 
 * Fixed bug where a method name which has `on_` followed by anything not an allowed color would return an underlined string.

data/README.md

@@ -1,9 +1,13 @@
 # crayon
 
-### current version : 1.0.0
+### current version : 1.0.3
 
 [http://github.com/mikowitz/crayon][github]
 
+### version warnings
+
+* `puts` and `print` will be deprecated. `Crayon` will no longer contain an IO object, but will only return strings
+
 ## Description
 
 A simple, flexible gem that provides an open-ended API to print colored and styled output to the terminal.
@@ -35,29 +39,34 @@ The following are all methods that `Crayon` understands, and should give you an
     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.
+### `puts` and `print` deprecation warning
+
+As of version 1.0.2, `puts` and `print` no longer control adding a newline to the end of Crayon-ed text. The methods themselves will remain in the code base until version 1.1.0, but will issue deprecation warnings, and have no real effect on the code. Instead of a line of code looking like this:
+
+    Crayon.print.red("red, ").blue("blue, ").puts.green("and green")
 
-    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.")
+you have a line of code like this:
 
-`puts` and `print` set an internal, persistent variable, so a specified newline presence or absence will last until `puts` or `print` is invoked again.
+    puts Crayon.red("red, ").blue("blue, ").green("and green")
 
-    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.")
+This change is mostly due to the fact that defining Crayon's IO object would make using Crayon inside of another project more complicated than it would need to be. Crayon now simply returns a formatted string.
+
+### chaining
 
 You can also chain color calls without having to call `Crayon` multiple times
 
-    Crayon.print.red("red").blue("blue").puts.green("green")
+    Crayon.red("red").blue("blue").green("green")
+
+### case flexibility
 
 `Crayon` will also handle mixed-case method calls
 
     Crayon.ReD_ON_gREEN("It's Christmas!")
 
+Of course, this is no different from calling
+
+    Crayon.red_on_green("It's Christmas!")
+
 ## Flexibility
 
 The order of elements in the method name is unimportant. For example

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.3

data/lib/crayon.rb

@@ -1,9 +1,15 @@
+$:.unshift File.dirname(__FILE__) + "/crayon"
+
+%w{ method_parser string_builder}.each {|file| require file }
+
 module Crayon
+  include Crayon::MethodParser
+  include Crayon::StringBuilder
   extend self
 
   class << self
     # @private
-    attr_accessor :foreground, :background, :formatting, :method_name, :color, :newline
+    attr_accessor :foreground, :background, :formatting, :method_name, :color
   end
 
   # @private
@@ -13,98 +19,29 @@ module Crayon
   # @private
   TERMINATION_STRING = "\e[0m"
 
-  # @private
-  def newline?; @newline.nil? ? true : @newline; end
-  # @private
-  def io; $stderr; end
-
-  def self.print; @newline = false; return Crayon; end
+  def self.print
+    Kernel::puts "Color.print is deprecated and will be removed in version 1.1.0."
+    return Crayon
+  end
 
-  def self.puts; @newline = true; return Crayon; end
+  def self.puts
+    Kernel::puts "Color.puts is deprecated and will be removed in version 1.1.0."
+    return Crayon
+  end
 
   def method_missing(method_name, string)
+    nullify_variables
     @method_name = method_name
     parse_method_name
-    io.print prepare_string(string)
-    nullify_variables
-    Crayon
-  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.downcase.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")
-      _background = @method_name.delete_at(_idx)
-      _background if COLORS.keys.include?(_background)
-    end
-  end
-
-  # @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 if @foreground || @background || !@formatting.empty?),
-      (newline? ? "\n" : "")
-    ].join("")
-  end
-
-  # @private
-  def prepare_foreground_color
-    @color = @foreground
-    handle_color(3)
-  end
-
-  # @private
-  def prepare_background_color
-    @color = @background
-    handle_color(4)
-  end
-
-  # @private
-  def prepare_formatting
-    return "" if @formatting.empty?
-    @formatting.map{|format| "\e[#{FORMATS[format]}m"}.join("")
-  end
-
-  # @private
-  def handle_color(lead)
-    return "" unless @color
-    "\e[#{lead}#{COLORS[@color]}m"
+    CrayonString.new(prepare_string(string) || "")
   end
 
   # @private
   def nullify_variables
     @foreground, @background, @formatting = nil, nil, []
     @method_name, @color = nil, nil
-    io.flush
   end
 end
+
+require 'crayon_string'
+

data/lib/crayon/crayon_string.rb

@@ -0,0 +1,10 @@
+class CrayonString < String
+  include Crayon
+
+  def method_missing(method_name, string)
+    nullify_variables
+    @method_name = method_name
+    parse_method_name
+    CrayonString.new(self + prepare_string(string))
+  end
+end

data/lib/crayon/method_parser.rb

@@ -0,0 +1,32 @@
+module Crayon
+  module MethodParser
+    ##
+    # Converts a method name into color and formatting parameters
+    # @private
+    def parse_method_name
+      @method_name = @method_name.to_s.downcase.split("_")
+      @background = parse_background
+      @foreground = parse_foreground
+      @formatting = parse_formatting
+    end
+
+    # @private
+    def parse_background
+      _idx = @method_name.index("on")
+      return nil unless _idx
+      @method_name.delete("on")
+      _background = @method_name.delete_at(_idx)
+      _background if COLORS.keys.include?(_background)
+    end
+
+    # @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
+  end
+end

data/lib/crayon/string_builder.rb

@@ -0,0 +1,39 @@
+module Crayon
+  module StringBuilder
+    ##
+    # Builds output string with color escape characters.
+    # @private
+    def prepare_string(string)
+      [ prepare_foreground_color,
+        prepare_background_color,
+        prepare_formatting,
+        string,
+        (TERMINATION_STRING if @foreground || @background || !@formatting.empty?)
+      ].compact.join("")
+    end
+
+    # @private
+    def prepare_foreground_color
+      @color = @foreground
+      handle_color(3)
+    end
+
+    # @private
+    def prepare_background_color
+      @color = @background
+      handle_color(4)
+    end
+
+    # @private
+    def prepare_formatting
+      return "" if @formatting.empty?
+      @formatting.map{|format| "\e[#{FORMATS[format]}m"}.join("")
+    end
+
+    # @private
+    def handle_color(lead)
+      return "" unless @color
+      "\e[#{lead}#{COLORS[@color]}m"
+    end
+  end
+end

data/spec/crayon_spec.rb

@@ -30,23 +30,8 @@ def test_prepare_string(expected_output, *args)
 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
-  it "chaining color calls should be allowed by return Crayon from method_missing" do
-    Crayon.red("OK").should == Crayon
+  it "chaining color calls should be allowed by returning a CrayonString from method_missing" do
+    Crayon.red("OK").should be_a CrayonString
   end
   describe "method_missing" do
     describe "should call :prepare string" do
@@ -55,21 +40,6 @@ describe "Crayon" 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, [])
@@ -100,20 +70,9 @@ describe "Crayon" do
   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
+    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
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Michael Berkowitz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-21 00:00:00 -04:00
+date: 2010-04-22 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -38,6 +38,9 @@ files:
 - Rakefile
 - VERSION
 - lib/crayon.rb
+- lib/crayon/crayon_string.rb
+- lib/crayon/method_parser.rb
+- lib/crayon/string_builder.rb
 - spec/crayon_spec.rb
 - spec/helper.rb
 - spec/spec.opts