pastel 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3a74798586ce6f5429d3c76faad4e3445319463
-  data.tar.gz: c2b581122d3029f273f29d5c6fcb9cbca064cc64
+  metadata.gz: 20dcaf43ced285d36ad7074808b52e6963e2da79
+  data.tar.gz: 592af5b9be60dbd781e909a3dc29222cfc68eef0
 SHA512:
-  metadata.gz: c47eac8d882f22e8dc9c1217497ce9f4a2aea4371d523801e8c37261aad1fc9f03d8f2e7f45c7ab168f22c68621331e9201d7363d5ae357a129596110a7fa27c
-  data.tar.gz: e7fdf3e1428864ad525fb50dfb3fe6f9f760ce7923d91af73b7f9df054f22e51dbc0db969cbd2def2bcce3b4d6b8337addbc0ac1b406395fb88bf106f5ae8434
+  metadata.gz: bf6a4be639512821cf4e990dbb0a6a15a4e0f009912161be8b9f429bf9287985baa02202378d80ae2b2d8b3de218319150b713f929ed6ec5fb17006e96a530e7
+  data.tar.gz: 204a5342e5b5e2e29d1cd50896db08c8d543467a18d0efac9cfe39a77536aca277f630a7716981aff33239b1a05cac2701d6644c0f224e232704b90eb6a62ba2

data/CHANGELOG.md

@@ -1,6 +1,12 @@
+0.4.0 (November 22, 2014)
+
+* Fix Delegator#respond_to method to correctly report existence of methods
+* Add ability to #detach color combination for later reuse
+* Add ability to nest styles with blocks
+
 0.3.0 (November 8, 2014)
 
-* Add ability to alias colors through alias_color method
+* Add ability to alias colors through #alias_color method
 * Add ability to alias colors through the environment variable
 * Improve performance of Pastel::Color styles and lookup methods
 * Fix bug concerned with lack of escaping for nested styles

data/README.md

@@ -2,12 +2,14 @@
 [![Gem Version](https://badge.fury.io/rb/pastel.png)][gem]
 [![Build Status](https://secure.travis-ci.org/peter-murach/pastel.png?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/peter-murach/pastel.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/peter-murach/pastel/badge.png)][coverage]
 
 [gem]: http://badge.fury.io/rb/pastel
 [travis]: http://travis-ci.org/peter-murach/pastel
 [codeclimate]: https://codeclimate.com/github/peter-murach/pastel
+[coverage]: https://coveralls.io/r/peter-murach/pastel
 
-Terminal output styling with intuitive and clean API that doesn't monkey patch String class.
+> Terminal output styling with intuitive and clean API that doesn't monkey patch String class.
 
 **Pastel** is minimal and focused to work in all terminal emulators.
 
@@ -43,11 +45,12 @@ Or install it yourself as:
 * [2. Interface](#2-interface)
   * [2.1 Color](#21-color)
   * [2.2 Decorate](#22-decorate)
-  * [2.3 Strip](#23-strip)
-  * [2.4 Styles](#24-styles)
-  * [2.5 Valid?](#25-valid)
-  * [2.6 Enabled?](#26-enabled)
-  * [2.7 Alias Color](#27-alias-color)
+  * [2.3 Detach](#23-detach)
+  * [2.4 Strip](#24-strip)
+  * [2.5 Styles](#25-styles)
+  * [2.6 Valid?](#26-valid)
+  * [2.7 Enabled?](#27-enabled)
+  * [2.8 Alias Color](#28-alias-color)
 * [3. Supported Colors](#3-supported-colors)
 * [4. Environment](#4-environment)
 
@@ -58,19 +61,19 @@ Or install it yourself as:
 ```ruby
 pastel = Pastel.new
 
-pastel.red('Unicorns!')
+puts pastel.red('Unicorns!')
 ```
 
-It allows you to combine styled strings with regular ones:
+You can compose multiple styles through chainable API:
 
 ```ruby
-pastel.red('Unicorns') + ' will rule ' + pastel.green('the World!')
+pastel.red.on_green.bold('Unicorns!')
 ```
 
-You can compose multiple styles through chainable API:
+It allows you to combine styled strings with unstyled ones:
 
 ```ruby
-pastel.red.on_green.bold('Unicorns!')
+pastel.red('Unicorns') + ' will rule ' + pastel.green('the World!')
 ```
 
 It supports variable number of arguments:
@@ -85,6 +88,32 @@ You can also nest styles as follows:
 pastel.red('Unicorns ', pastel.on_green('everywhere!'))
 ```
 
+Nesting is smart enough to know where one color ends and another one starts:
+
+```ruby
+pastel.red('Unicorns ' + pastel.green('everywhere') + pastel.on_yellow('!'))
+```
+
+You can also nest styles inside blocks:
+
+```ruby
+pastel.red.on_green('Unicorns') {
+  green.on_red('will ', 'dominate') {
+    yellow('the world!')
+  }
+}
+```
+
+You can also predefine needed styles and reuse them:
+
+```ruby
+error    = pastel.red.on_bold.detach
+warning  = pastel.yellow.detach
+
+puts error('Error!')
+puts warning('Warning')
+```
+
 ## 2 Interface
 
 ### 2.1 Color
@@ -107,15 +136,25 @@ pastel.decorate('Unicorn', :green, :on_blue, :bold)
 
 This method will be useful in situations where colors are provided as a list of parameters.
 
-### 2.3 Strip
+### 2.3 Detach
+
+The `detach` method allows to keep all the coloring for later reference. This method is useful when detached colors are being resued frequently and thus shorthand version is preferred.
+
+```ruby
+notice = pastel.blue.bold.detach
+puts notice.call('Unicorns running')
+puts notice.call('They are super wild')
+```
+
+### 2.4 Strip
 
 Strip all color sequence characters from the provided strings. The return value will be eithre array of modified strings or a single string. The arguments are not modified.
 
 ```ruby
-pastel.strip("\e[1m\e[34mbold blue text\e[0m"")  # => "bold blue text"
+pastel.strip("\e[1m\e[34mbold blue text\e[0m")  # => "bold blue text"
 ```
 
-### 2.4 Styles
+### 2.5 Styles
 
 To get a full list of supported styles with the corresponding color codes do:
 
@@ -123,7 +162,7 @@ To get a full list of supported styles with the corresponding color codes do:
 pastel.styles
 ```
 
-### 2.5 Valid?
+### 2.6 Valid?
 
 Determine whether a color or a list of colors are valid. `valid?` takes one or more attribute strings or symbols and returns true if all attributes are known and false otherwise.
 
@@ -132,7 +171,7 @@ pastel.valid?(:red, :blue) # => true
 pastel.valid?(:unicorn)    # => false
 ```
 
-### 2.6 Enabled?
+### 2.7 Enabled?
 
 In order to detect if your terminal supports coloring do:
 
@@ -147,7 +186,7 @@ pastel = Pastel.new(enabled: true)
 pastel.enabled?   # => false
 ```
 
-### 2.7 Alias Color
+### 2.8 Alias Color
 
 In order to setup an alias for the standard color do:
 
@@ -231,7 +270,7 @@ This environment variable allows you to specify custom color aliases at runtime
 Only alphanumeric and `_` are allowed in the alias names with the following format:
 
 ```ruby
-PASTEL_COLORS_ALIASES='newcolor_1=red,newcolor_2=on_gree'
+PASTEL_COLORS_ALIASES='newcolor_1=red,newcolor_2=on_green'
 ```
 
 ## Contributing

data/benchmarks/nesting_speed.rb

@@ -0,0 +1,26 @@
+require 'pastel'
+require 'benchmark/ips'
+
+pastel = Pastel.new
+
+Benchmark.ips do |bench|
+  bench.config(time: 5, warmup: 2)
+
+  bench.report('regular nesting') do
+    pastel.red.on_green('Unicorns' +
+      pastel.green.on_red('will ', 'dominate' + pastel.yellow('the world!')))
+  end
+
+  bench.report('block nesting') do
+    pastel.red.on_green('Unicorns') do
+      green.on_red('will ', 'dominate') do
+        yellow('the world!')
+      end
+    end
+  end
+
+  bench.compare!
+end
+
+# regular nesting: 2800/s
+# block nesting:   2600/s

data/benchmarks/speed.rb

@@ -6,11 +6,16 @@ pastel = Pastel.new
 Benchmark.ips do |bench|
   bench.config(time: 5, warmup: 2)
 
-  bench.report('styles') do
-    pastel.styles
+  bench.report('color decorate') do
+    pastel.decorate('string', :red, :on_green, :bold)
   end
 
-  bench.report('decorate') do
-    pastel.decorate('string', :red, :on_green, :bold)
+  bench.report('dsl styling') do
+    pastel.red.on_green.bold('string')
   end
+
+  bench.compare!
 end
+
+# color decorate: 14K/s
+# dsl styling:    10K/s

data/lib/pastel.rb

@@ -8,6 +8,7 @@ require 'pastel/alias_importer'
 require 'pastel/color'
 require 'pastel/color_resolver'
 require 'pastel/delegator'
+require 'pastel/detached'
 require 'pastel/decorator_chain'
 require 'pastel/version'
 

data/lib/pastel/color_resolver.rb

@@ -21,9 +21,12 @@ module Pastel
     # Resolve uncolored string
     #
     # @api private
-    def resolve(base, *args)
-      unprocessed_string = args.join
-      color.decorate(unprocessed_string, *base)
+    def resolve(base, unprocessed_string)
+      if base.to_a.last == :detach
+        Detached.new(color, *base.to_a[0...-1])
+      else
+        color.decorate(unprocessed_string, *base)
+      end
     end
   end # ColorResolver
 end # Pastel

data/lib/pastel/decorator_chain.rb

@@ -8,8 +8,6 @@ module Pastel
     include Enumerable
     include Equatable
 
-    attr_reader :decorators
-
     def initialize(decorators = [])
       @decorators = decorators
     end
@@ -36,5 +34,9 @@ module Pastel
     def self.empty
       new([])
     end
+
+    protected
+
+    attr_reader :decorators
   end # DecoratorChain
 end # Patel

data/lib/pastel/delegator.rb

@@ -44,6 +44,9 @@ module Pastel
 
     attr_reader :resolver
 
+    # Wrap colors
+    #
+    # @api private
     def wrap(base)
       self.class.new(resolver, base)
     end
@@ -51,15 +54,25 @@ module Pastel
     def method_missing(method_name, *args, &block)
       new_base  = base.add(method_name)
       delegator = wrap(new_base)
-      if args.empty?
+      if args.empty? && !(method_name.to_sym == :detach)
         delegator
       else
-        resolver.resolve(new_base, *args)
+        string = args.join
+        string << evaluate_block(&block) if block_given?
+        resolver.resolve(new_base, string)
       end
     end
 
     def respond_to_missing?(name, include_all = false)
-      super || @resolver.color.respond_to?(name, include_all)
+      resolver.color.respond_to?(name, include_all) || valid?(name) || super
+    end
+
+    # Evaluate color block
+    #
+    # @api private
+    def evaluate_block(&block)
+      delegator = self.class.new(resolver, DecoratorChain.empty)
+      delegator.instance_eval(&block)
     end
   end # Delegator
 end # Pastel

data/lib/pastel/detached.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+module Pastel
+  # A class representing detached color
+  class Detached
+    include Equatable
+
+    def initialize(color, *styles)
+      @color  = color
+      @styles = styles.dup
+      freeze
+    end
+
+    # Decorate the values corresponding to styles
+    #
+    # @example
+    #
+    # @param [String] value
+    #   the stirng to decorate with styles
+    #
+    # @return [String]
+    #
+    # @api public
+    def call(*args)
+      value = args.join
+      @color.decorate(value, *styles)
+    end
+
+    private
+
+    # @api private
+    attr_reader :styles
+  end # Detached
+end # Pastel

data/lib/pastel/version.rb

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

data/spec/spec_helper.rb

@@ -1,5 +1,20 @@
 # encoding: utf-8
 
+if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
 require 'pastel'
 
 RSpec.configure do |config|

data/spec/unit/color/decorate_spec.rb

@@ -7,6 +7,11 @@ RSpec.describe Pastel::Color, '.decorate' do
 
   subject(:color) { described_class.new(enabled: true) }
 
+  it "doesn't output styling when disabled" do
+    color = described_class.new(enabled: false)
+    expect(color.decorate('foo', :red)).to eq('foo')
+  end
+
   it "doesn't apply styling to empty string" do
     expect(color.decorate('')).to eq('')
   end

data/spec/unit/detach_spec.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Pastel, '.detach' do
+
+  subject(:pastel) { described_class.new(enabled: true) }
+
+  it "detaches colors combination" do
+    error = pastel.red.bold.detach
+    expect(error.call('unicorn')).to eq("\e[31;1municorn\e[0m")
+    expect(error.call('error')).to eq("\e[31;1merror\e[0m")
+  end
+
+  it "calls detached colors with no arguments" do
+    warning = pastel.yellow.detach
+    expect(warning.call('')).to eq('')
+  end
+
+  it "inspects detached colors" do
+    warning = pastel.yellow.bold.detach
+    expect(warning.inspect).to eq('#<Pastel::Detached styles=[:yellow, :bold]>')
+  end
+
+  it "accepts multiple strings" do
+    error = pastel.red.bold.detach
+    expect(error.call('Unicorns', ' run ', 'wild')).
+      to eq("\e[31;1mUnicorns run wild\e[0m")
+  end
+end

data/spec/unit/new_spec.rb

@@ -59,6 +59,17 @@ RSpec.describe Pastel do
         to eq("\e[31mr\e[32mg\e[31mr\e[0m")
     end
 
+    it "allows to nest styles within block" do
+      string = pastel.red.on_green('Unicorns' +
+        pastel.green.on_red('will ', 'dominate' + pastel.yellow('the world!')))
+
+      expect(pastel.red.on_green('Unicorns') do
+        green.on_red('will ', 'dominate') do
+          yellow('the world!')
+        end
+      end).to eq(string)
+    end
+
     it "raises error when chained with unrecognized color" do
       expect {
         pastel.unknown.on_red('unicorn')

data/spec/unit/respond_to_spec.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Pastel, '.respond_to?' do
+  subject(:pastel) { described_class.new(enabled: true) }
+
+  it "responds correctly to color method" do
+    expect(pastel.respond_to?(:decorate)).to eq(true)
+  end
+
+  it "responds correctly to color property" do
+    expect(pastel.respond_to?(:red)).to eq(true)
+  end
+
+  it "responds correctly to unkown method" do
+    expect(pastel.respond_to?(:unknown)).to eq(false)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pastel
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-08 00:00:00.000000000 Z
+date: 2014-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equatable
@@ -56,6 +56,7 @@ files:
 - README.md
 - Rakefile
 - assets/screenshot.png
+- benchmarks/nesting_speed.rb
 - benchmarks/speed.rb
 - lib/pastel.rb
 - lib/pastel/alias_importer.rb
@@ -64,6 +65,7 @@ files:
 - lib/pastel/color_resolver.rb
 - lib/pastel/decorator_chain.rb
 - lib/pastel/delegator.rb
+- lib/pastel/detached.rb
 - lib/pastel/version.rb
 - pastel.gemspec
 - spec/spec_helper.rb
@@ -77,7 +79,9 @@ files:
 - spec/unit/color/supports_spec.rb
 - spec/unit/decorator_chain_spec.rb
 - spec/unit/delegator_spec.rb
+- spec/unit/detach_spec.rb
 - spec/unit/new_spec.rb
+- spec/unit/respond_to_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake
@@ -117,5 +121,7 @@ test_files:
 - spec/unit/color/supports_spec.rb
 - spec/unit/decorator_chain_spec.rb
 - spec/unit/delegator_spec.rb
+- spec/unit/detach_spec.rb
 - spec/unit/new_spec.rb
+- spec/unit/respond_to_spec.rb
 has_rdoc: