crayon 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b30625ac82f77101da7a8a6a9cdc5b2dbd3f5cb
+  data.tar.gz: e70445e3e4900fbb6f2430407493bc51b0e2b607
+SHA512:
+  metadata.gz: 039cb34deb386ca9d73624777bc7a581bb90cf5d23eb7b6e16a3f30ae62549fea49a87e6d0ff08dbbd55b5b1134dcd3dabc416ddaa8297fc0b24baa44ae3d0cf
+  data.tar.gz: ca7ea84bae10363fc1e735634441dbb98c41de627bc12641e861b3fc7ce73d87778d8e73d09b3c216eedb2f5c3024276bc2fcec5424d0c632b92102f83a1e46f

data/.gitignore

@@ -1,2 +1,2 @@
-bench.rb
-*.html
+.DS_Store
+/pkg

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+- jruby-19mode
+- rbx-2

data/Gemfile

@@ -1,3 +1,4 @@
-source "http://rubygems.org"
-gem "yard"
-gem "rspec"
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crayon.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    crayon (1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  crayon!
+  rake (~> 10.0)
+  rspec

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Michael Berkowitz
+Copyright (c) 2014 Michael Berkowitz
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,4 @@
-# crayon
-
-### current version : 1.1.0
+# crayon 1.2.0
 
 [http://github.com/mikowitz/crayon][github]
 
@@ -10,24 +8,16 @@ A simple, flexible gem that provides an open-ended API to print colored and styl
 
 ## Installation
 
-Install the gemcutter gem
-
-    ~$ gem install gemcutter
-
-Add gemcutter.org to your gem remote sources
+Add `Crayon` to your Gemfile
 
-    ~$ gem tumble
+    gem "crayon"
 
-Download and install this gem
+Or 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")
@@ -41,13 +31,19 @@ You can also chain color calls without having to call `Crayon` multiple times
 
     Crayon.red("red").blue("blue").green("green")
 
+### clearing
+
+You can call `clear` to insert plain text in the middle of formatted content
+
+    Crayon.red("red").clear("plain").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
+This is no different from calling
 
     Crayon.red_on_green("It's Christmas!")
 
@@ -61,11 +57,9 @@ 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.
-
 ## Return values
 
-Crayon simply returns a formatted string
+Crayon returns a formatted string
 
     Color.red("red, ").blue("and blue") #=> "\e[31mred, \e[0m\e[34mand blue\e[0m"
 
@@ -73,6 +67,6 @@ So any call to `Crayon` must be `puts` or `print`-ed in order for the content to
 
 ## Copyright
 
-Copyright (c) 2010 Michael Berkowitz. See LICENSE for details.
+Copyright (c) 2014 Michael Berkowitz. See LICENSE.txt for details.
 
 [github]: http://github.com/mikowitz/crayon "Crayon repository"

data/Rakefile

@@ -1,48 +1,6 @@
-require 'rake'
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "crayon"
-    gem.summary = %Q{a new version of 'color' with a less common name.}
-    gem.description = %Q{A simple, flexible gem that provides an open-ended API to print colored and styled output to the terminal.}
-    gem.email = "michael.berkowitz@gmail.com"
-    gem.homepage = "http://github.com/mikowitz/crayon"
-    gem.authors = ["Michael Berkowitz"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+RSpec::Core::RakeTask.new('spec')
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << "lib" << "spec"
-  spec.spec_files = FileList["spec/**/*_spec.rb"]
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << "lib" << "spec"
-  spec.pattern = "spec/**/*_spec.rb"
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-task :default => :spec
-
-desc "'Proof is the bottom line for everyone' -- Paul Simon"
-task :proof do
-  system "ruby test/proof.rb"
-end
-
-begin
-  require 'yard'
-  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"
-  end
-end
+task default: :spec

data/crayon.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "crayon/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "crayon"
+  spec.version       = Crayon::VERSION
+  spec.authors       = ["Michael Berkowitz"]
+  spec.email         = ["michael.berkowitz@gmail.com"]
+  spec.summary       = %q{Colored terminal output}
+  spec.description = %Q{A simple, flexible gem that provides an open-ended API to print colored and styled output to the terminal.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/crayon.rb

@@ -1,6 +1,5 @@
-$:.unshift File.dirname(__FILE__) + "/crayon"
-
-%w{ method_parser string_builder}.each {|file| require file }
+require "crayon/method_parser"
+require "crayon/string_builder"
 
 module Crayon
   include Crayon::MethodParser
@@ -8,30 +7,18 @@ module Crayon
   extend self
 
   class << self
-    # @private
     attr_accessor :foreground, :background, :formatting, :method_name, :color
   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 method_missing(method_name, string)
-    nullify_variables
     @method_name = method_name
     parse_method_name
     CrayonString.new(prepare_string(string) || "")
   end
-
-  # @private
-  def nullify_variables
-    @foreground, @background, @formatting = nil, nil, []
-    @method_name, @color = nil, nil
-  end
 end
 
-require 'crayon_string'
-
+require "crayon/crayon_string"

data/lib/crayon/crayon_string.rb

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

data/lib/crayon/method_parser.rb

@@ -1,32 +1,25 @@
 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("_")
+      @method_name_components = @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)
+      on_index = @method_name_components.index("on")
+      return nil unless on_index
+      background = @method_name_components.delete_at(on_index + 1)
+      background if COLORS.include?(background)
     end
 
-    # @private
     def parse_foreground
-      @method_name.find {|color| COLORS.keys.include?(color) }
+      @method_name_components.find {|color| COLORS.include?(color) }
     end
 
-    # @private
     def parse_formatting
-      @method_name.select {|format| FORMATS.keys.include?(format) }
+      @method_name_components.select {|format| FORMATS.include?(format) }
     end
   end
 end

data/lib/crayon/string_builder.rb

@@ -1,39 +1,34 @@
 module Crayon
   module StringBuilder
-    ##
-    # Builds output string with color escape characters.
-    # @private
     def prepare_string(string)
-      [ prepare_foreground_color,
-        prepare_background_color,
-        prepare_formatting,
+      [ foreground_string,
+        background_string,
+        formatting_string,
         string,
-        (TERMINATION_STRING if @foreground || @background || !@formatting.empty?)
+        (TERMINATION_STRING if has_color?)
       ].compact.join("")
     end
 
-    # @private
-    def prepare_foreground_color
-      @color = @foreground
-      handle_color(3)
+    def has_color?
+      @foreground || @background || @formatting.any?
     end
 
-    # @private
-    def prepare_background_color
-      @color = @background
-      handle_color(4)
+    def foreground_string
+      handle_color(3, @foreground)
     end
 
-    # @private
-    def prepare_formatting
+    def background_string
+      handle_color(4, @background)
+    end
+
+    def formatting_string
       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"
+    def handle_color(lead, color)
+      return "" unless color
+      "\e[#{lead}#{COLORS[color]}m"
     end
   end
 end

data/lib/crayon/version.rb

@@ -0,0 +1,3 @@
+module Crayon
+  VERSION = "1.2.0"
+end

data/spec/{crayon_spec.rb → crayon/crayon_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/helper")
+require "spec_helper"
 
 def test_parse_method_name(input, *output)
   describe "for input :#{input}" do
@@ -7,40 +7,42 @@ def test_parse_method_name(input, *output)
       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
+      expect(Crayon.foreground).to eq @fore
     end
     it "should return #{@back.inspect} for background" do
-      Crayon.background.should == @back
+      expect(Crayon.background).to eq @back
     end
     it "should return #{@form.inspect} for formatting" do
-      Crayon.formatting.should == @form
+      expect(Crayon.formatting).to eq @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
+    Crayon.foreground = args.fetch(1, nil)
+    Crayon.background = args.fetch(2, nil)
+    Crayon.formatting = args.fetch(3, [])
+    expect(Crayon.prepare_string(args.first)).to eq expected_output
   end
 end
 
 describe "Crayon" do
   describe "chaining color calls" do
     it "should be allowed by returning a CrayonString from method_missing" do
-      Crayon.red("OK").should be_a CrayonString
+      expect(Crayon.red("OK")).to 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"
+      expect(Crayon.red("OK").blue("OK").underline("OK")).to eq "\e[31mOK\e[0m\e[34mOK\e[0m\e[4mOK\e[0m"
+    end
+    it "should allow plain text in the middle of formatted text via .clear" do
+      expect(Crayon.red("OK").clear(" OK ").underline("OK")).to eq "\e[31mOK\e[0m OK \e[4mOK\e[0m"
     end
   end
   describe "method_missing" do
     describe "should call :prepare string" do
-      before { Crayon.should_receive(:prepare_string).with("hello") }
+      before { expect(Crayon).to receive(:prepare_string).with("hello") }
       it "when Crayon.red is called" do
         Crayon.red("hello")
       end

data/spec/{helper.rb → spec_helper.rb}

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

metadata

@@ -1,80 +1,105 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: crayon
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 1.2.0
 platform: ruby
-authors: 
+authors:
 - Michael Berkowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-04-22 00:00:00 -04:00
-default_executable: 
-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
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+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: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.html
-- README.md
-files: 
-- .document
-- .gitignore
-- CHANGELOG.md
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- LICENSE
+- Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
+- crayon.gemspec
 - 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
-- README.html
-has_rdoc: true
-homepage: http://github.com/mikowitz/crayon
-licenses: []
-
+- lib/crayon/version.rb
+- spec/crayon/crayon_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: a new version of 'color' with a less common name.
-test_files: 
-- spec/crayon_spec.rb
-- spec/helper.rb
+specification_version: 4
+summary: Colored terminal output
+test_files:
+- spec/crayon/crayon_spec.rb
+- spec/spec_helper.rb

data/CHANGELOG.md

@@ -1,43 +0,0 @@
-### 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`
-
-### 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.
-* Set `method_missing` to return `Crayon` so color methods can be chained.
-* Crayon can handle mixed-case method names.
-
-### 0.0.5 : 04/21/10
-
-* Moved functionality from passing variables between methods to using instance variables.
-
-### 0.0.4 : 04/21/10
-
-* Adds documentation and hides most helper methods from public documentation.
-
-### 0.0.3 : 04/21/10
-
-* Switches documentation from RDoc to Markdown
-* Moves gem dependencies into Gemfile
-* Switches tests over to RSpec
-
-
-### 0.0.2 : 03/15/10
-
-* Swtiches testing to Tinytest
-* Adds basic functionality
-* Adds sample output file and rake task

data/VERSION

@@ -1 +0,0 @@
-1.1.0

data/spec/spec.opts

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