tty-color 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f283dfbe29783ae7e0c276ab7c0b826bb3a3597a
-  data.tar.gz: cd78c6a3723d0faa4bb9ca4e9d079f53ef6c495d
+  metadata.gz: e202bf4ea2e5da8b715888731cf0e9488afde5db
+  data.tar.gz: 63d578fe8363573b353d4f0cf867c5c0f78f9b5d
 SHA512:
-  metadata.gz: 8ca5f9b0fb1a004ff63783bb39b39c8f4eb45323f2a1be4eafb01c747c3b35254ae1fac793c0d629503e246c3d1a8a54024fecf7bcabc19bd8fba5b96f4c5e7d
-  data.tar.gz: df3075abac7aa41d018fee562276a888a1dd346d8dee6b6c4df62cdcfbca0e56dc44ade95e09fe6a27e081cd743f59bd69c000901b1db7ad38fdfeb0b9cf389a
+  metadata.gz: 5db3f22c98af1803e7fe028263f4f95d3a3fb89e7008cc33f9ce4cc5e5066232be6e8cc7d4f5fb84fda2171525965a3bb53fe13d2cd796dcb58a6b0a667e02aa
+  data.tar.gz: 4547260a08d17f7f11181a38d4f68876a7ef81c8f7388524042f5e704ba0fdc5e34a788fc959f0c7004db430fa2c61d6482e3854343e9640da274034ad0c9a11

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 # Change log
 
+## [v0.2.0] - 2016-01-13
+
+### Changed
+
+* Change ordering of color support checks by @janlelis
+* Change ordering of color mode
+* Change Support#from_env to check ansicon
+* Ensure #tty? works for non-terminal devices
+* Remove color executable
+
 ## [v0.1.0] - 2016-01-02
 
 * Initial implementation and release
 
+[v0.2.0]: https://github.com/peter-murach/tty-color/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/peter-murach/tty-color/compare/v0.1.0

data/README.md

@@ -58,19 +58,18 @@ puts color?
 
 ## Command line tool
 
-**TTY::Color** comes with a command line tool to detect color support in terminal. The results are redirected to standard output.
+[tty-color-cli](https://github.com/peter-murach/tty-color-cli) is a command line tool for the **TTY::Color**.
+
+To check if terminal supports colors do:
 
 ```bash
-color
 color -s
-color --support
 ```
 
-and to check number of colors:
+and to check color mode:
 
 ```bash
 color -m
-color --mode
 ```
 
 ## Contributing

data/lib/tty/color.rb

@@ -19,6 +19,11 @@ module TTY
 
     attr_accessor :output, :verbose
 
+    # Check if terminal supports colors
+    #
+    # @return [Boolean]
+    #
+    # @api public
     def supports?
       Support.new(ENV, verbose: verbose).supports?
     end
@@ -34,9 +39,13 @@ module TTY
       Mode.new(ENV).mode
     end
 
-    # @api private
+    # Check if output is linked with terminal
+    #
+    # @return [Boolean]
+    #
+    # @api public
     def tty?
-      output.tty?
+      output.respond_to(:tty?) && output.tty?
     end
   end # Color
 end # TTY

data/lib/tty/color/mode.rb

@@ -35,7 +35,7 @@ module TTY
         return 0 unless TTY::Color.tty?
 
         value = 8
-        %w(from_tput from_term).each do |from_check|
+        %w(from_term from_tput).each do |from_check|
           break if (value = public_send(from_check)) != NoValue
         end
         return 8 if value == NoValue
@@ -67,7 +67,7 @@ module TTY
       #
       # @api private
       def from_tput
-        colors = %x(tput colors 2>/dev/null).to_i
+        colors = `tput colors 2>/dev/null`.to_i
         colors >= 8 ? colors : NoValue
       rescue Errno::ENOENT
         NoValue

data/lib/tty/color/support.rb

@@ -3,6 +3,8 @@
 module TTY
   module Color
     class Support
+      SOURCES = %w(from_term from_tput from_env from_curses).freeze
+
       # Initialize a color support
       # @api public
       def initialize(env, options = {})
@@ -20,13 +22,40 @@ module TTY
         return false unless TTY::Color.tty?
 
         value = false
-        %w(from_curses from_tput from_term from_env).each do |from_check|
+        SOURCES.each do |from_check|
           break if (value = public_send(from_check)) != NoValue
         end
         return false if value == NoValue
         value
       end
 
+      # Inspect environment $TERM variable for color support
+      #
+      # @api private
+      def from_term
+        case @env['TERM']
+        when 'dumb' then false
+        when /^screen|^xterm|^vt100|color|ansi|cygwin|linux/i then true
+        else NoValue
+        end
+      end
+
+      # Shell out to tput to check color support
+      #
+      # @api private
+      def from_tput
+        `tput colors 2>/dev/null`.to_i > 2
+      rescue Errno::ENOENT
+        NoValue
+      end
+
+      # Check if environment specifies color variables
+      #
+      # @api private
+      def from_env
+        ['COLORTERM', 'ANSICON'].any? { |key| @env.key?(key) } || NoValue
+      end
+
       # Attempt to load curses to check color support
       #
       # @return [Boolean]
@@ -48,33 +77,6 @@ module TTY
         warn 'no native curses support' if @verbose
         NoValue
       end
-
-      # Shell out to tput to check color support
-      #
-      # @api private
-      def from_tput
-        %x(tput colors 2>/dev/null).to_i > 2
-      rescue Errno::ENOENT
-        NoValue
-      end
-
-      # Inspect environment $TERM variable for color support
-      #
-      # @api private
-      def from_term
-        case @env['TERM']
-        when 'dumb' then false
-        when /^screen|^xterm|^vt100|color|ansi|cygwin|linux/i then true
-        else NoValue
-        end
-      end
-
-      # Check if environment specifies color term
-      #
-      # @api private
-      def from_env
-        @env.include?('COLORTERM')
-      end
     end # Support
   end # Color
 end # TTY

data/lib/tty/color/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Color
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end # Color
 end # TTY

data/spec/unit/mode_spec.rb

@@ -12,61 +12,83 @@ RSpec.describe TTY::Color::Mode, 'detecting mode' do
     mode = described_class.new({})
     allow(mode).to receive(:from_term).and_return(TTY::Color::NoValue)
     allow(mode).to receive(:from_tput).and_return(TTY::Color::NoValue)
+
     expect(mode.mode).to eq(8)
+    expect(mode).to have_received(:from_term).ordered
+    expect(mode).to have_received(:from_tput).ordered
   end
 
-  it 'infers mode for xterm-256color' do
+  it "detects color mode" do
+    allow(TTY::Color).to receive(:tty?).and_return(true)
     mode = described_class.new('TERM' => 'xterm-256color')
-    expect(mode.from_term).to eq(256)
-  end
 
-  it 'infers mode for iTerm.app' do
-    mode = described_class.new('TERM' => 'iTerm.app')
-    expect(mode.from_term).to eq(256)
+    expect(mode.mode).to eq(256)
   end
 
-  it 'infers mode from terminal environment' do
-    mode = described_class.new('TERM' => 'amiga-8bit')
-    expect(mode.from_term).to eq(256)
-  end
+  context '#from_term' do
+    it 'infers mode for xterm-256color' do
+      mode = described_class.new('TERM' => 'xterm-256color')
+      expect(mode.from_term).to eq(256)
+    end
 
-  it 'infers mode for wy730' do
-    mode = described_class.new('TERM' => 'wy370-105k')
-    expect(mode.from_term).to eq(64)
-  end
+    it 'infers mode for iTerm.app' do
+      mode = described_class.new('TERM' => 'iTerm.app')
+      expect(mode.from_term).to eq(256)
+    end
 
-  it 'infers mode for d430-unix-ccc' do
-    mode = described_class.new('TERM' => 'd430-unix-ccc')
-    expect(mode.from_term).to eq(52)
-  end
+    it 'infers mode from terminal environment' do
+      mode = described_class.new('TERM' => 'amiga-8bit')
+      expect(mode.from_term).to eq(256)
+    end
 
-  it 'infers mode for d430-unix-s-ccc' do
-    mode = described_class.new('TERM' => 'd430c-unix-s-ccc')
-    expect(mode.from_term).to eq(52)
-  end
+    it 'infers mode for wy730' do
+      mode = described_class.new('TERM' => 'wy370-105k')
+      expect(mode.from_term).to eq(64)
+    end
 
-  it 'infers mode for nsterm-bce' do
-    mode = described_class.new('TERM' => 'nsterm-bce')
-    expect(mode.from_term).to eq(16)
-  end
+    it 'infers mode for d430-unix-ccc' do
+      mode = described_class.new('TERM' => 'd430-unix-ccc')
+      expect(mode.from_term).to eq(52)
+    end
 
-  it 'infers mode for d430-c' do
-    mode = described_class.new('TERM' => 'd430c-dg')
-    expect(mode.from_term).to eq(16)
-  end
+    it 'infers mode for d430-unix-s-ccc' do
+      mode = described_class.new('TERM' => 'd430c-unix-s-ccc')
+      expect(mode.from_term).to eq(52)
+    end
 
-  it 'infers mode for d430-unix-w' do
-    mode = described_class.new('TERM' => 'd430-unix-w')
-    expect(mode.from_term).to eq(16)
-  end
+    it 'infers mode for nsterm-bce' do
+      mode = described_class.new('TERM' => 'nsterm-bce')
+      expect(mode.from_term).to eq(16)
+    end
 
-  it 'infers mode for vt100' do
-    mode = described_class.new('TERM' => 'konsole-vt100')
-    expect(mode.from_term).to eq(8)
-  end
+    it 'infers mode for d430-c' do
+      mode = described_class.new('TERM' => 'd430c-dg')
+      expect(mode.from_term).to eq(16)
+    end
+
+    it 'infers mode for d430-unix-w' do
+      mode = described_class.new('TERM' => 'd430-unix-w')
+      expect(mode.from_term).to eq(16)
+    end
+
+    it 'infers mode for vt100' do
+      mode = described_class.new('TERM' => 'konsole-vt100')
+      expect(mode.from_term).to eq(8)
+    end
+
+    it 'infers mode for xnuppc' do
+      mode = described_class.new('TERM' => 'xnuppc+basic')
+      expect(mode.from_term).to eq(8)
+    end
+
+    it 'infers mode fro dummy terminal' do
+      mode = described_class.new('TERM' => 'dummy')
+      expect(mode.from_term).to eq(0)
+    end
 
-  it 'infers mode for xnuppc' do
-    mode = described_class.new('TERM' => 'xnuppc+basic')
-    expect(mode.from_term).to eq(8)
+    it "doesn't match any term variable" do
+      mode = described_class.new({})
+      expect(mode.from_term).to eq(TTY::Color::NoValue)
+    end
   end
 end

data/spec/unit/supports_spec.rb

@@ -17,54 +17,96 @@ RSpec.describe TTY::Color::Support, '#supports?' do
     allow(support).to receive(:from_env).and_return(TTY::Color::NoValue)
 
     expect(support.supports?).to eq(false)
+
+    expect(support).to have_received(:from_term).ordered
+    expect(support).to have_received(:from_tput).ordered
+    expect(support).to have_received(:from_env).ordered
+    expect(support).to have_received(:from_curses).ordered
   end
 
-  it "fails to load curses for color support" do
-    support = described_class.new({})
-    allow(support).to receive(:require).with('curses').
-      and_raise(LoadError)
-    allow(support).to receive(:warn)
+  it "detects color support" do
+    support = described_class.new('TERM' => 'xterm')
+    allow(TTY::Color).to receive(:tty?).and_return(true)
+    allow(support).to receive(:from_tput)
 
-    expect(support.from_curses).to eq(TTY::Color::NoValue)
-    expect(support).to_not have_received(:warn)
+    expect(support.supports?).to eq(true)
+    expect(support).to_not have_received(:from_tput)
   end
 
-  it "sets verbose mode on" do
-    support = described_class.new({}, verbose: true)
-    allow(support).to receive(:require).with('curses').
-      and_raise(LoadError)
-    allow(support).to receive(:warn)
+  context '#from_curses' do
+    it "fails to load curses for color support" do
+      support = described_class.new({})
+      allow(support).to receive(:require).with('curses').
+        and_raise(LoadError)
+      allow(support).to receive(:warn)
 
-    support.from_curses
+      expect(support.from_curses).to eq(TTY::Color::NoValue)
+      expect(support).to_not have_received(:warn)
+    end
 
-    expect(support).to have_received(:warn).with(/no native curses support/)
-  end
+    it "fails to find Curses namespace" do
+      support = described_class.new({})
+      allow(support).to receive(:require).with('curses')
 
-  it "loads curses for color support" do
-    support = described_class.new({})
-    allow(support).to receive(:require).with('curses').and_return(true)
-    stub_const("Curses", Object.new)
-    curses = double(:curses)
-    allow(curses).to receive(:init_screen)
-    allow(curses).to receive(:has_colors?).and_return(true)
-    allow(curses).to receive(:close_screen)
-
-    expect(support.from_curses(curses)).to eql(true)
-    expect(curses).to have_received(:has_colors?)
-  end
+      expect(support.from_curses).to eq(TTY::Color::NoValue)
+    end
+
+    it "sets verbose mode on" do
+      support = described_class.new({}, verbose: true)
+      allow(support).to receive(:require).with('curses').
+        and_raise(LoadError)
+      allow(support).to receive(:warn)
 
-  it "fails to find color for dumb terminal" do
-    support = described_class.new('TERM' => 'dumb')
-    expect(support.from_term).to eq(false)
+      support.from_curses
+
+      expect(support).to have_received(:warn).with(/no native curses support/)
+    end
+
+    it "loads curses for color support" do
+      support = described_class.new({})
+      allow(support).to receive(:require).with('curses').and_return(true)
+      stub_const("Curses", Object.new)
+      curses = double(:curses)
+      allow(curses).to receive(:init_screen)
+      allow(curses).to receive(:has_colors?).and_return(true)
+      allow(curses).to receive(:close_screen)
+
+      expect(support.from_curses(curses)).to eql(true)
+      expect(curses).to have_received(:has_colors?)
+    end
   end
 
-  it "inspects term variable for color capabilities" do
-    support = described_class.new('TERM' => 'xterm')
-    expect(support.from_term).to eq(true)
+  context '#form_term' do
+    it "fails to find color for dumb terminal" do
+      support = described_class.new('TERM' => 'dumb')
+      expect(support.from_term).to eq(false)
+    end
+
+    it "inspects term variable for color capabilities" do
+      support = described_class.new('TERM' => 'xterm')
+      expect(support.from_term).to eq(true)
+    end
+
+    it "fails to find color capabilities from term variable " do
+      support = described_class.new('TERM' => 'atari')
+      expect(support.from_term).to eq(TTY::Color::NoValue)
+    end
   end
 
-  it "inspects color terminal variable for support" do
-    support = described_class.new('COLORTERM' => true)
-    expect(support.from_env).to eq(true)
+  context '#from_env' do
+    it "finds color support in colorterm variable" do
+      support = described_class.new('COLORTERM' => true)
+      expect(support.from_env).to eq(true)
+    end
+
+    it "finds ansicon support" do
+      support = described_class.new('ANSICON' => true)
+      expect(support.from_env).to eq(true)
+    end
+
+    it "doesn't find any keys in environment" do
+      support = described_class.new({})
+      expect(support.from_env).to eq(TTY::Color::NoValue)
+    end
   end
 end

data/tasks/console.rake

@@ -4,7 +4,7 @@ desc 'Load gem inside irb console'
 task :console do
   require 'irb'
   require 'irb/completion'
-  require File.join(__FILE__, '../../lib/pastel')
+  require File.join(__FILE__, '../../lib/tty-color')
   ARGV.clear
   IRB.start
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-color
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-02 00:00:00.000000000 Z
+date: 2016-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,8 +47,7 @@ dependencies:
 description: Terminal color capabilities detection
 email:
 - ''
-executables:
-- color
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -60,7 +59,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/color
 - lib/tty-color.rb
 - lib/tty/color.rb
 - lib/tty/color/mode.rb

data/bin/color

@@ -1,42 +0,0 @@
-#!/usr/bin/env ruby
-
-Signal.trap("INT") { exit 1 }
-
-lib_dir = File.expand_path("../../lib", __FILE__)
-$LOAD_PATH.unshift(lib_dir) if File.directory?(lib_dir)
-
-require 'optparse'
-require 'tty-color'
-
-options = {}
-
-parser = OptionParser.new do |opts|
-  opts.on('-s', '--support', 'Check if terminal supports colors') do
-    options[:color] = true
-  end
-
-  opts.on('-m', '--mode', 'Supported colors mode') do
-    options[:mode] = true
-  end
-
-  options[:verbose] = false
-  opts.on('-v', '--verbose', 'Output debug information' ) do
-    options[:verbose] = true
-  end
-
-  opts.on('-h', '--help', 'Display help' ) do
-    puts opts
-    exit
-  end
-end
-
-parser.parse!
-
-TTY::Color.verbose = options[:verbose]
-
-if options[:mode]
-  puts TTY::Color.mode
-else
-  puts TTY::Color.color?
-end
-