crayon 1.0.3 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 1.1.0 : 04/22/10
+
+* Removed `puts` and `print` methods
+
+### 1.0.3 : 04/22/10
+
+* Broke Crayon functionality out into separate modules
+* Added CrayonString class to allow chaining methods
+
+### 1.0.2 : 04/21/10
+
+* Removed last references to the `newline` and `io` methods.
+
 ### 1.0.1 : 04/21/10
 
 * Adds deprecation warnings for `puts` and `print`

data/README.md

@@ -1,13 +1,9 @@
 # crayon
 
-### current version : 1.0.3
+### current version : 1.1.0
 
 [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.
@@ -39,18 +35,6 @@ 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")
 
-### `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")
-
-you have a line of code like this:
-
-    puts Crayon.red("red, ").blue("blue, ").green("and green")
-
-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
@@ -79,6 +63,14 @@ will look the same as
 
 Check out `test/proof.rb` and `~$ rake proof` if you don't believe me.
 
+## Return values
+
+Crayon simply returns a formatted string
+
+    Color.red("red, ").blue("and blue") #=> "\e[31mred, \e[0m\e[34mand blue\e[0m"
+
+So any call to `Crayon` must be `puts` or `print`-ed in order for the content to be displayed with the proper coloring.
+
 ## Copyright
 
 Copyright (c) 2010 Michael Berkowitz. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.1.0

data/lib/crayon.rb

@@ -19,16 +19,6 @@ module Crayon
   # @private
   TERMINATION_STRING = "\e[0m"
 
-  def self.print
-    Kernel::puts "Color.print is deprecated and will be removed in version 1.1.0."
-    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

data/spec/crayon_spec.rb

@@ -30,8 +30,13 @@ def test_prepare_string(expected_output, *args)
 end
 
 describe "Crayon" do
-  it "chaining color calls should be allowed by returning a CrayonString from method_missing" do
-    Crayon.red("OK").should be_a CrayonString
+  describe "chaining color calls" do
+    it "should be allowed by returning a CrayonString from method_missing" do
+      Crayon.red("OK").should be_a CrayonString
+    end
+    it "should return the full chained string" do
+      Crayon.red("OK").blue("OK").underline("OK").should == "\e[31mOK\e[0m\e[34mOK\e[0m\e[4mOK\e[0m"
+    end
   end
   describe "method_missing" do
     describe "should call :prepare string" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 3
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors: 
 - Michael Berkowitz