pastel 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df0d822f2378510e2c8f751d179c208585fb2e38
-  data.tar.gz: bf0a8a93193af9c35ff862e0e69373d97bf29d51
+  metadata.gz: eab704ae6d2747d9d0fc40eb19843f91c7dfb331
+  data.tar.gz: f51ab97939b6375f973c16d0215398dd6ad9c97f
 SHA512:
-  metadata.gz: 7dcf28176858eeaccc03eb33d702214274e72d32082887d66938afa1f7d6f38b24fa7523437ed4249d51e6c7425db729e42ad50cd83daf0747ea953abb96157c
-  data.tar.gz: c6a17854cb0c7328474da74d4c8ffee8f0af6c757f729bbef91ec02da7202e91d4da108ef318be8dcf4ab51e1fa20a9985cd8e3ed35c4f5f50db3de7e888488d
+  metadata.gz: c26988ce864c70a9bb5e23de8d85895e69d2449dbf09a8f5d611e92187b7f64ca02fb1ada0f29a9c0fbf1576e44248be5fff5d06dcd775fb36262a4bb98aa8d1
+  data.tar.gz: 29401a138ed3646c77d3b85f49a772266c4acc1662c57d3cd1ae91d8149c1b783e33c262cc5465e73d1b422bb36ded104720d8b13604e580ee9c1ab6d1e7769c

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+0.2.0 (October 12, 2014)
+
+* Change gemspec to include equatable as dependency
+* Add #supports? to Color to check for terminal color support
+* Add ability to force color support through :enabled option
+* Change Delegator to stop creating instances and improve performance

data/README.md

@@ -11,6 +11,8 @@ Terminal output styling with intuitive and clean API that doesn't monkey patch S
 
 **Pastel** is minimal and focused to work in all terminal emulators.
 
+![screenshot](https://github.com/peter-murach/pastel/raw/master/assets/screenshot.png)
+
 ## Features
 
 * Doesn't monkey patch `String`
@@ -42,6 +44,7 @@ Or install it yourself as:
   * [2.3 Strip](#23-strip)
   * [2.4 Styles](#24-styles)
   * [2.5 Valid?](#25-valid)
+  * [2.6 Enabled?](#26-enabled)
 * [3. The available styles](#3-the-available-styles)
 
 ## 1 Usage
@@ -66,7 +69,7 @@ You can compose multiple styles through chainable API:
 pastel.red.on_green.bold('Unicorns!')
 ```
 
-It supports variable number of arguments with individual styling:
+It supports variable number of arguments:
 
 ```ruby
 pastel.red('Unicorns', 'are', 'running', 'everywhere!')
@@ -85,7 +88,7 @@ pastel.red('Unicorns ', pastel.on_green('everywhere!'))
 You can pass variable number of styled strings like so:
 
 ```ruby
-pastel.red('Unicorns', pastel.on_yellow('are running', pastel.bold.underline('everywhere')), '!')
+pastel.red('Unicorns ', pastel.bold.underline('everywhere'), '!')
 ```
 
 Please refer to [3. The available styles](#3-the-available-styles) section for full list of supported styles.
@@ -123,6 +126,21 @@ pastel.valid?(:red)     # => true
 pastel.valid?(:unicorn) # => false
 ```
 
+### 2.6 Enabled?
+
+In order to detect if your terminal supports coloring do:
+
+```ruby
+pastel.enabled?   # => false
+```
+
+In cases when the color support is not provided no styling will be applied to the colored string. Moreover, you can force **Pastel** to always print out string with coloring switched on:
+
+```ruby
+pastel = Pastel.new(enabled: true)
+pastel.enabled?   # => false
+```
+
 ## 3 The available styles
 
 **Pastel** works with terminal emulators that support minimum sixteen colors. It provides `16` basic colors and `8` styles with further `16` bright color pairs. The corresponding bright color is obtained by prepending the `bright` to the normal color name. For example, color `red` will have `bright_red` as its pair.

data/lib/pastel.rb

@@ -12,8 +12,18 @@ module Pastel
   # Raised when the style attribute is not supported
   InvalidAttributeNameError = Class.new(::ArgumentError)
 
-  def new
-    Delegator.for(DecoratorChain.empty)
+  # Create Pastel chainable API
+  #
+  # @example
+  #   pastel = Pastel.new enabled: true
+  #
+  # @return [Delegator]
+  #
+  # @api public
+  def new(options = {})
+    color    = Color.new(options)
+    resolver = ColorResolver.new(color)
+    Delegator.for(resolver, DecoratorChain.empty)
   end
 
   module_function :new

data/lib/pastel/ansi.rb

@@ -30,6 +30,7 @@ module Pastel
     BRIGHT_BLUE    = "\e[94m"
     BRIGHT_MAGENTA = "\e[95m"
     BRIGHT_CYAN    = "\e[96m"
+    BRIGHT_WHITE   = "\e[97m"
 
     # Escape codes for background color.
     ON_BLACK         = "\e[40m"
@@ -48,6 +49,7 @@ module Pastel
     ON_BRIGHT_BLUE    = "\e[104m"
     ON_BRIGHT_MAGENTA = "\e[105m"
     ON_BRIGHT_CYAN    = "\e[106m"
+    ON_BRIGHT_WHITE   = "\e[107m"
 
     BACKGROUND_COLORS = constants.grep(/^ON_*/).freeze
   end # ANSI

data/lib/pastel/color.rb

@@ -7,12 +7,13 @@ module Pastel
     include ANSI
 
     attr_reader :enabled
+    alias_method :enabled?, :enabled
 
     # Initialize a Terminal Color
     #
     # @api public
-    def initialize(enabled = false)
-      @enabled = enabled
+    def initialize(options = {})
+      @enabled = options.fetch(:enabled) { supports? }
     end
 
     # Disable coloring of this terminal session
@@ -22,6 +23,22 @@ module Pastel
       @enabled = false
     end
 
+    # Detect terminal color support
+    #
+    # @return [Boolean]
+    #   true when terminal supports color, false otherwise
+    #
+    # @api public
+    def supports?
+      return false unless $stdout.tty?
+      return false if ENV['TERM'] == 'dumb'
+      if ENV['TERM'] =~ /^screen|^xterm|^vt100|color|ansi|cygwin|linux/i
+        return true
+      end
+      return true if ENV.include?('COLORTERM')
+      true
+    end
+
     # Apply ANSI color to the given string.
     #
     # @param [String] string
@@ -36,7 +53,7 @@ module Pastel
     #
     # @api public
     def decorate(string, *colors)
-      return string if string.empty?
+      return string if string.empty? || !enabled
       validate(*colors)
       ansi_colors = colors.map { |color| lookup(color) }
       ansi_string = "#{ansi_colors.join}#{string}#{ANSI::CLEAR}"

data/lib/pastel/color_resolver.rb

@@ -9,6 +9,11 @@ module Pastel
   class ColorResolver
     attr_reader :color
 
+    # Initialize ColorResolver
+    #
+    # @param [Color] color
+    #
+    # @api private
     def initialize(color = Color.new)
       @color = color
     end

data/lib/pastel/delegator.rb

@@ -7,29 +7,33 @@ module Pastel
   # @api private
   class Delegator
     extend Forwardable
+    include Equatable
 
-    attr_reader :base
-
-    attr_reader :resolver
+    def_delegators '@resolver.color', :valid?, :styles, :strip, :decorate, :enabled?
 
-    def_delegators :@color, :valid?, :styles, :strip, :decorate
-
-    def initialize(base)
-      @base = base
-      @color = Color.new
-      @resolver = ColorResolver.new(@color)
+    def initialize(resolver, base)
+      @resolver = resolver
+      @base     = base
     end
 
     # @api public
-    def self.for(value)
-      new(value)
+    def self.for(resolver, base)
+      new(resolver, base)
     end
 
     protected
 
+    attr_reader :base
+
+    attr_reader :resolver
+
+    def wrap(base)
+      self.class.new(resolver, base)
+    end
+
     def method_missing(method_name, *args, &block)
       new_base  = base.add(method_name)
-      delegator = self.class.new(new_base)
+      delegator = wrap(new_base)
       if args.empty?
         delegator
       else
@@ -38,7 +42,7 @@ module Pastel
     end
 
     def respond_to_missing?(name, include_all = false)
-      super || @color.respond_to?(name, include_all)
+      super || @resolver.color.respond_to?(name, include_all)
     end
   end # Delegator
 end # Pastel

data/lib/pastel/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 
 module Pastel
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/pastel.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "equatable", "~> 0.5"
+
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "equatable", "~> 0.5"
 end

data/spec/unit/color/code_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 RSpec.describe Pastel::Color, '.code' do
   let(:string) { "This is a \e[1m\e[34mbold blue text\e[0m" }
 
-  subject(:color) { described_class.new }
+  subject(:color) { described_class.new(enabled: true) }
 
   it 'finds single code' do
     expect(color.code(:black)).to eq(["\e[30m"])

data/spec/unit/color/decorate_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 RSpec.describe Pastel::Color, '.decorate' do
   let(:string) { 'string' }
 
-  subject(:color) { described_class.new }
+  subject(:color) { described_class.new(enabled: true) }
 
   it "doesn't apply styling to empty string" do
     expect(color.decorate('')).to eq('')

data/spec/unit/color/strip_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Pastel::Color, '.strip' do
-  let(:instance) { described_class.new }
+  let(:instance) { described_class.new(enabled: true) }
 
   subject(:color) { instance.strip(string) }
 

data/spec/unit/color/styles_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 RSpec.describe Pastel::Color do
 
-  subject(:color) { described_class.new }
+  subject(:color) { described_class.new(enabled: true) }
 
   it "exposes all available style ANSI codes" do
     expect(color.styles[:red]).to eq("\e[31m")

data/spec/unit/color/supports_spec.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Pastel::Color, '.supports?' do
+  it "isn't enabled for non tty terminal" do
+    allow($stdout).to receive(:tty?).and_return(false)
+    color = described_class.new
+
+    expect(color.enabled?).to eq(false)
+    expect(color.decorate("Unicorn", :red)).to eq("Unicorn")
+  end
+
+  it "isn't enabled for dumb terminal" do
+    allow($stdout).to receive(:tty?).and_return(true)
+    allow(ENV).to receive(:[]).with('TERM').and_return('dumb')
+    color = described_class.new
+
+    expect(color.enabled?).to eq(false)
+  end
+
+  it "is enabled for term with color support" do
+    allow($stdout).to receive(:tty?).and_return(true)
+    allow(ENV).to receive(:[]).with('TERM').and_return('xterm')
+    color = described_class.new
+
+    expect(color.enabled?).to eq(true)
+  end
+
+  it "is enabled for color terminal" do
+    allow($stdout).to receive(:tty?).and_return(true)
+    allow(ENV).to receive(:[]).with('TERM').and_return('unknown')
+    allow(ENV).to receive(:[]).with('COLORTERM').and_return(true)
+    color = described_class.new
+
+    expect(color.enabled?).to eq(true)
+  end
+
+  it "forces to be enabled with supports? check" do
+    color = described_class.new(enabled: false)
+    allow(color).to receive(:supports?)
+
+    expect(color.enabled?).to eq(false)
+    expect(color).to_not have_received(:supports?)
+  end
+end

data/spec/unit/delegator_spec.rb

@@ -6,16 +6,18 @@ RSpec.describe Pastel::Delegator do
   describe ".respond_to_missing?" do
     context 'for a method defined on' do
       it "returns true" do
+        resolver = double(:resolver)
         chain = double(:chain)
-        decorator = described_class.new(chain)
+        decorator = described_class.new(resolver, chain)
         expect(decorator.method(:styles)).not_to be_nil
       end
     end
 
     context "for an undefined method " do
       it "returns false" do
+        resolver = double(:resolver, color: true)
         chain = double(:chain)
-        decorator = described_class.new(chain)
+        decorator = described_class.new(resolver, chain)
         expect { decorator.method(:unknown) }.to raise_error(NameError)
       end
     end

data/spec/unit/new_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 RSpec.describe Pastel do
 
-  subject(:pastel) { described_class.new }
+  subject(:pastel) { described_class.new(enabled: true) }
 
   describe 'coloring string' do
     it "doesn't apply styles to empty string" do
@@ -55,7 +55,11 @@ RSpec.describe Pastel do
     end
   end
 
-  it "respond to styles method" do
-    expect(pastel).to respond_to(:styles)
+  describe 'options passed in' do
+    it "receives enabled option" do
+      pastel = described_class.new(enabled: false)
+      expect(pastel.enabled?).to eq(false)
+      expect(pastel.red('Unicorn', pastel.green('!'))).to eq('Unicorn!')
+    end
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pastel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-11 00:00:00.000000000 Z
+date: 2014-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: equatable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: '0.5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: equatable
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.6'
 description: Terminal strings styling with intuitive and clean API.
 email:
 - ''
@@ -50,10 +50,12 @@ files:
 - .ruby-gemset
 - .ruby-version
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/screenshot.png
 - lib/pastel.rb
 - lib/pastel/ansi.rb
 - lib/pastel/color.rb
@@ -67,6 +69,7 @@ files:
 - spec/unit/color/decorate_spec.rb
 - spec/unit/color/strip_spec.rb
 - spec/unit/color/styles_spec.rb
+- spec/unit/color/supports_spec.rb
 - spec/unit/decorator_chain_spec.rb
 - spec/unit/delegator_spec.rb
 - spec/unit/new_spec.rb
@@ -103,6 +106,7 @@ test_files:
 - spec/unit/color/decorate_spec.rb
 - spec/unit/color/strip_spec.rb
 - spec/unit/color/styles_spec.rb
+- spec/unit/color/supports_spec.rb
 - spec/unit/decorator_chain_spec.rb
 - spec/unit/delegator_spec.rb
 - spec/unit/new_spec.rb