tty-color-cli 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5793488c8568cf4ac5da13dfa174744860dc392
-  data.tar.gz: b57ac42036f2232514dbbee8830aa4e866b6d7f4
+SHA256:
+  metadata.gz: b2420e960c6be6d7e080838a50972135dfe1468bd4e6d6ec6b097054a0665404
+  data.tar.gz: 669933eeb29b299ec61b79b18651414ac5419e747098db798c3cf342d81d26f5
 SHA512:
-  metadata.gz: 6b6476abd4ba6b8f339cce8c04c9a59a659e040ba132054782a6992d6b34692d992b51f5fb9bb9e6d2e231417dab945eea20a71d245322ee2214e4116ea74672
-  data.tar.gz: 877f253e0afd687d63aacdf2f3decb1ce566e98fda4c3335f62d43e051f83b128607806239cfd29f82a83d262d3dae0287c93bf1575f163c53a5eed5e5866e0c
+  metadata.gz: e16424a8637fefc4e267896b4eaac28c23f01fea549dc14bd133b4faec8bc54fbc467747ac3ad05c33cad0f81b0bddcf9876ac0766a0cb40da7957f2a7ec896f
+  data.tar.gz: 3c2012c5b11ff8b69804108165f1166d4422fbeff9f9b3cdb830585a14be051cbe7da61cdae8edc8f33f1619adc0c77b8182be809b3c7539668560ac5c98aa4c

data/CHANGELOG.md

@@ -1,7 +1,28 @@
 # Change log
 
+## [v0.3.0] - 2020-08-09
+
+### Add
+* Add tty-color.1 manual page
+
+### Changed
+* Change executable name from color to tty-color
+* Change executable to stop raising error and exit with a message
+* Change --verbose to --debug option
+* Change gemspec to remove test files, load executable directly
+* Change gemspec to require Ruby 2.0 or higher
+* Change to update tty-color dependency
+* Change executable to print newline
+
+## [v0.2.0] - 2016-12-27
+
+### Changed
+* Change to update tty-color dependency
+
 ## [v0.1.0] - 2016-03-05
 
 Initial release
 
-[v0.1.0]: https://github.com/peter-murach/tty-color-cli/compare/v0.1.0
+[v0.3.0]: https://github.com/piotrmurach/tty-color-cli/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/piotrmurach/tty-color-cli/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-color-cli/compare/v0.1.0

data/README.md

@@ -3,15 +3,11 @@
 [![Gem Version](https://badge.fury.io/rb/tty-color-cli.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/tty-color-cli.svg?branch=master)][travis]
 [![Build status](https://ci.appveyor.com/api/projects/status/tr24h4edq3xqafkn?svg=true)][appveyor]
-[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-color-cli/badges/gpa.svg)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-color-cli/badge.svg)][coverage]
 
 [gitter]: https://gitter.im/piotrmurach/tty
 [gem]: http://badge.fury.io/rb/tty-color-cli
 [travis]: http://travis-ci.org/piotrmurach/tty-color-cli
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-color-cli
-[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-color-cli
-[coverage]: https://coveralls.io/github/piotrmurach/tty-color-cli
 
 > CLI tool for terminal color capabilities detection
 
@@ -22,7 +18,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty-color-cli'
+gem "tty-color-cli"
 ```
 
 And then execute:
@@ -35,25 +31,25 @@ Or install it yourself as:
 
 ## Usage
 
-Running `color` with `-h` or `--help` flats will display help information:
+Running `tty-color` with `-h` or `--help` flags will display help information:
 
 ```bash
-$ color --help
+$ tty-color --help
 ```
 
-**TTY::Color** comes with a command line tool to detect color support in terminal. The results are redirected to standard output.
+To check for terminal color support run `tty-color` or pass a flag `--support` or `-s` like so:
 
 ```bash
-color
-color -s
-color --support
+tty-color
+tty-color -s
+tty-color --support
 ```
 
-and to check number of colors:
+To check number of supported colors do:
 
 ```bash
-color -m
-color --mode
+tty-color -m
+tty-color --mode
 ```
 
 ## Contributing
@@ -64,6 +60,10 @@ color --mode
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Code of Conduct
+
+Everyone interacting in the tty-color-cli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-color-cli/blob/master/CODE_OF_CONDUCT.md).
+
 ## Copyright
 
-Copyright (c) 2016-2017 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2016 Piotr Murach. See LICENSE for further details.

data/exe/tty-color

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+Signal.trap("INT") { exit 1 }
+
+require "optparse"
+require "tty-color"
+
+options = {}
+
+ARGV << "-h" if ARGV.empty?
+
+parser = OptionParser.new do |opts|
+  opts.on("-m", "--mode", "Check maximum number of supported colors") do
+    options[:mode] = true
+  end
+
+  opts.on("-s", "--support", "Check terminal for color support") do
+    options[:color] = true
+  end
+
+  options[:verbose] = false
+  opts.on("-d", "--debug", "Display debug information" ) do
+    options[:verbose] = true
+  end
+
+  opts.on("-h", "--help", "Display help" ) do
+    puts opts
+    exit
+  end
+
+  opts.on("-v", "--version", "Display the version") do
+    puts "0.3.0 (tty-color #{TTY::Color::VERSION})"
+    exit
+  end
+end
+
+begin
+  parser.parse!
+rescue OptionParser::ParseError => error
+  $stderr.puts error.message
+  exit 1
+end
+
+TTY::Color.verbose = options[:verbose]
+
+puts(options[:mode] ? TTY::Color.mode : TTY::Color.color?)

data/exe/ttycolor

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+load File.expand_path("../tty-color", __FILE__)

data/man/tty-color.1

@@ -0,0 +1,35 @@
+.\" generated by kramdown
+.TH "TTY\-COLOR" "1"
+.SH "NAME"
+\fBtty\-color\fP \- query terminal for color support or check number of colors
+.SH "SYNOPSIS"
+\fBtty\-color\fP [options]
+.SH "DESCRIPTION"
+The \fBtty\-color\fP utility queries terminal for color support and checks how many colors can be displayed\.
+.P
+The options are as follows:
+.TP
+\fB\-m\fP, \fB\-\-mode\fP
+Checks number of supported colors
+.TP
+\fB\-s\fP, \fB\-\-support\fP
+Checks terminal for color support
+.TP
+\fB\-d\fP, \fB\-\-debug\fP
+Display debug information
+.SH "EXAMPLES"
+Print if terminal supports colors to the standard output:
+.P
+tty\-color \-s
+.P
+Print the number of colors to the standard output:
+.P
+tty\-color \(emmode
+.SH "EXIT STATUS"
+The \fBtty\-color\fP utility exits 0 on success, and 1 if an error occurs\.
+.SH "SEE ALSO"
+The \fBtty\-color\fP readme https://github\.com/piotrmurach/tty\-color
+.SH "AUTHOR"
+The \fBtty\-color\fP utility is written by Piotr Murach <piotr@piotrmurach\.com>
+.P
+Website: https://ttytoolkit\.org

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-color-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2020-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-color
@@ -16,34 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,34 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: CLI tool for terminal color capabilities detection
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A command-line tool for terminal color capabilities detection
 email:
-- ''
+- piotr@piotrmurach.com
 executables:
-- color
+- tty-color
+- ttycolor
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- bin/color
-- spec/spec_helper.rb
-- spec/unit/color_command_spec.rb
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-color-cli.gemspec
-homepage: http://piotrmurach.github.io/tty/
+- exe/tty-color
+- exe/ttycolor
+- man/tty-color.1
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-color-cli/issues
+  changelog_uri: https://github.com/piotrmurach/tty-color-cli/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-color-cli
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-color-cli
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -94,18 +102,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: CLI tool for terminal color capabilities detection
-test_files:
-- spec/spec_helper.rb
-- spec/unit/color_command_spec.rb
+summary: A command-line tool for terminal color capabilities detection
+test_files: []

data/.codeclimate.yml

@@ -1,11 +0,0 @@
----
-engines:
-  rubocop:
-      enabled: true
-ratings:
-  paths:
-    - bin/*
-exclude_paths:
-  - spec/**/*
-  - examples/**/*
-  - tasks/**/*

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---warnings

data/.travis.yml

@@ -1,27 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-bundler_args: --without yard benchmarks
-script: "bundle exec rake ci"
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-  - jruby-9000
-  - jruby-head
-  - ruby-head
-  - rbx-2
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: jruby-9000
-    - rvm: rbx-2
-  fast_finish: true
-branches:
-  only: master
-notifications:
-  email: false

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-  gem 'rspec',     '~> 3.5.0'
-  gem 'simplecov', '~> 0.11.2'
-  gem 'coveralls', '~> 0.8.2'
-  gem 'term-ansicolor', '=1.3.2'
-end

data/Rakefile

@@ -1,8 +0,0 @@
-# encoding: utf-8
-
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]

data/appveyor.yml

@@ -1,23 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake ci
-environment:
-  matrix:
-    - ruby_version: "193"
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
-matrix:
-  allow_failures:
-    - ruby_version: "193"

data/bin/color

@@ -1,34 +0,0 @@
-#!/usr/bin/env ruby
-
-Signal.trap("INT") { exit 1 }
-
-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]
-
-print(options[:mode] ? TTY::Color.mode : TTY::Color.color?)

data/spec/spec_helper.rb

@@ -1,45 +0,0 @@
-# encoding: utf-8
-
-$:.unshift File.expand_path("../../bin", __FILE__)
-
-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
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  if config.files_to_run.one?
-    config.default_formatter = 'doc'
-  end
-
-  config.profile_examples = 2
-
-  config.order = :random
-
-  Kernel.srand config.seed
-end

data/spec/unit/color_command_spec.rb

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-RSpec.describe 'color command' do
-  it 'runs without arguments' do
-    expect(`bin/color`).to match(/true/)
-    expect($?.exitstatus).to eq(0)
-  end
-
-  it 'shows help' do
-    expect(`bin/color --help`).to eq([
-      "Usage: color [options]\n",
-      "    -s, --support                    Check if terminal supports colors\n",
-      "    -m, --mode                       Supported colors mode\n",
-      "    -v, --verbose                    Output debug information\n",
-      "    -h, --help                       Display help\n"
-    ].join)
-    expect($?.exitstatus).to eq(0)
-  end
-
-  it "detects mode" do
-    expect(`bin/color --mode`).to match(/(\d+)/)
-    expect($?.exitstatus).to eq(0)
-  end
-
-  it "runs in verbose mode" do
-    expect(`bin/color --verbose --mode`).to match(/(\d+)/)
-    expect($?.exitstatus).to eq(0)
-  end
-end

data/tasks/coverage.rake

@@ -1,11 +0,0 @@
-# encoding: utf-8
-
-desc 'Measure code coverage'
-task :coverage do
-  begin
-    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
-    Rake::Task['spec'].invoke
-  ensure
-    ENV['COVERAGE'] = original
-  end
-end

data/tasks/spec.rake

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-begin
-  require 'rspec/core/rake_task'
-
-  desc 'Run all specs'
-  RSpec::Core::RakeTask.new(:spec) do |task|
-    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
-  end
-
-  namespace :spec do
-    desc 'Run unit specs'
-    RSpec::Core::RakeTask.new(:unit) do |task|
-      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
-    end
-
-    desc 'Run integration specs'
-    RSpec::Core::RakeTask.new(:integration) do |task|
-      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
-    end
-  end
-
-rescue LoadError
-  %w[spec spec:unit spec:integration].each do |name|
-    task name do
-      $stderr.puts "In order to run #{name}, do `gem install rspec`"
-    end
-  end
-end

data/tty-color-cli.gemspec

@@ -1,21 +0,0 @@
-# coding: utf-8
-
-Gem::Specification.new do |spec|
-  spec.name          = 'tty-color-cli'
-  spec.version       = '0.2.0'
-  spec.authors       = ['Piotr Murach']
-  spec.email         = ['']
-  spec.summary       = %q{CLI tool for terminal color capabilities detection}
-  spec.description   = %q{CLI tool for terminal color capabilities detection}
-  spec.homepage      = "http://piotrmurach.github.io/tty/"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = ['color']
-  spec.test_files    = spec.files.grep(%r{^spec/})
-
-  spec.add_dependency 'tty-color', '~> 0.4.0'
-
-  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
-  spec.add_development_dependency 'rake'
-end