powerdlz23 1.2.4 → 1.2.5

package/snapcrawl/CHANGELOG.md

@@ -0,0 +1,182 @@
+Change Log
+========================================
+
+v0.5.4 - 2023-07-27
+----------------------------------------
+
+- Drop support for Ruby <= 2.6
+- Upgrade dependencies and rubocop cleanup
+- Fix css_selector option
+- Drop support for Ruby 2.x
+
+
+v0.5.3 - 2021-03-29
+----------------------------------------
+
+- Add skip_ssl_verification config option
+- Add screenshot_delay config option
+
+
+v0.5.2 - 2021-02-25
+----------------------------------------
+
+- Fix logging percent issue
+
+
+## [v0.5.1](https://github.com/DannyBen/snapcrawl/tree/v0.5.1) (2020-03-14)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.5.0...v0.5.1)
+
+**Merged pull requests:**
+
+- Add additional test cases and exception safeguards [\#30](https://github.com/DannyBen/snapcrawl/pull/30) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.5.0](https://github.com/DannyBen/snapcrawl/tree/v0.5.0) (2020-03-14)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.5.0.rc1...v0.5.0)
+
+**Merged pull requests:**
+
+- Epic refactor [\#29](https://github.com/DannyBen/snapcrawl/pull/29) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.5.0.rc1](https://github.com/DannyBen/snapcrawl/tree/v0.5.0.rc1) (2020-03-14)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.4.4...v0.5.0.rc1)
+
+## [v0.4.4](https://github.com/DannyBen/snapcrawl/tree/v0.4.4) (2020-03-12)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.4.3...v0.4.4)
+
+**Merged pull requests:**
+
+- Rescue imagemagick exceptions [\#28](https://github.com/DannyBen/snapcrawl/pull/28) ([DannyBen](https://github.com/DannyBen))
+- Switch to github actions [\#27](https://github.com/DannyBen/snapcrawl/pull/27) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.4.3](https://github.com/DannyBen/snapcrawl/tree/v0.4.3) (2020-01-09)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.4.2...v0.4.3)
+
+## [v0.4.2](https://github.com/DannyBen/snapcrawl/tree/v0.4.2) (2020-01-09)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.4.1...v0.4.2)
+
+**Merged pull requests:**
+
+- Improve handling of malformed URIs [\#26](https://github.com/DannyBen/snapcrawl/pull/26) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.4.1](https://github.com/DannyBen/snapcrawl/tree/v0.4.1) (2020-01-09)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.4.0...v0.4.1)
+
+**Merged pull requests:**
+
+- Updates for ruby 2.7 [\#25](https://github.com/DannyBen/snapcrawl/pull/25) ([DannyBen](https://github.com/DannyBen))
+- Test with ruby 2.7 [\#23](https://github.com/DannyBen/snapcrawl/pull/23) ([DannyBen](https://github.com/DannyBen))
+- Improve error handling [\#20](https://github.com/DannyBen/snapcrawl/pull/20) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.4.0](https://github.com/DannyBen/snapcrawl/tree/v0.4.0) (2020-01-01)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.3.1...v0.4.0)
+
+**Merged pull requests:**
+
+- Remove go subcommand [\#22](https://github.com/DannyBen/snapcrawl/pull/22) ([DannyBen](https://github.com/DannyBen))
+- Make CI more consistent [\#21](https://github.com/DannyBen/snapcrawl/pull/21) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.3.1](https://github.com/DannyBen/snapcrawl/tree/v0.3.1) (2019-09-11)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.3.0...v0.3.1)
+
+**Fixed bugs:**
+
+- Try catch error instead of stopping script [\#19](https://github.com/DannyBen/snapcrawl/issues/19)
+- error : Cliver::Dependency::VersionMismatch [\#18](https://github.com/DannyBen/snapcrawl/issues/18)
+- RuntimeError redirection forbidden [\#16](https://github.com/DannyBen/snapcrawl/issues/16)
+
+## [v0.3.0](https://github.com/DannyBen/snapcrawl/tree/v0.3.0) (2019-09-10)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.8...v0.3.0)
+
+**Merged pull requests:**
+
+- Fixes round [\#17](https://github.com/DannyBen/snapcrawl/pull/17) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.2.8](https://github.com/DannyBen/snapcrawl/tree/v0.2.8) (2019-06-14)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.7...v0.2.8)
+
+**Closed issues:**
+
+- Improve tests and run tests on Travis [\#13](https://github.com/DannyBen/snapcrawl/issues/13)
+- Save all versions of snapshot? [\#11](https://github.com/DannyBen/snapcrawl/issues/11)
+
+**Merged pull requests:**
+
+- Add Travis CI [\#15](https://github.com/DannyBen/snapcrawl/pull/15) ([DannyBen](https://github.com/DannyBen))
+- Add ability to set filename template [\#14](https://github.com/DannyBen/snapcrawl/pull/14) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.2.7](https://github.com/DannyBen/snapcrawl/tree/v0.2.7) (2019-06-13)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.6...v0.2.7)
+
+**Closed issues:**
+
+- Using snapcrawl via proxy? [\#10](https://github.com/DannyBen/snapcrawl/issues/10)
+
+**Merged pull requests:**
+
+- Fix ignored --folder parameter [\#12](https://github.com/DannyBen/snapcrawl/pull/12) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.2.6](https://github.com/DannyBen/snapcrawl/tree/v0.2.6) (2019-04-18)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.5...v0.2.6)
+
+**Closed issues:**
+
+- Screenshots not saving to default snaps folder on Windows machine [\#6](https://github.com/DannyBen/snapcrawl/issues/6)
+- Add the ability to pass headers into the application [\#3](https://github.com/DannyBen/snapcrawl/issues/3)
+
+**Merged pull requests:**
+
+- Upgrade colsole to fix windows command\_exist [\#9](https://github.com/DannyBen/snapcrawl/pull/9) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.2.5](https://github.com/DannyBen/snapcrawl/tree/v0.2.5) (2019-03-14)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.4...v0.2.5)
+
+**Fixed bugs:**
+
+- Screenshots not saving to default or specified folder locations [\#4](https://github.com/DannyBen/snapcrawl/issues/4)
+
+**Merged pull requests:**
+
+- Alert when imagemagick is not installed [\#7](https://github.com/DannyBen/snapcrawl/pull/7) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.2.4](https://github.com/DannyBen/snapcrawl/tree/v0.2.4) (2018-10-18)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.3...v0.2.4)
+
+**Merged pull requests:**
+
+- Switch from screencap to webshot [\#5](https://github.com/DannyBen/snapcrawl/pull/5) ([DannyBen](https://github.com/DannyBen))
+- Switch from minitest to rspec [\#2](https://github.com/DannyBen/snapcrawl/pull/2) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.2.3](https://github.com/DannyBen/snapcrawl/tree/v0.2.3) (2017-03-15)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.2...v0.2.3)
+
+**Merged pull requests:**
+
+- Fixes [\#1](https://github.com/DannyBen/snapcrawl/pull/1) ([DannyBen](https://github.com/DannyBen))
+
+## [v0.2.2](https://github.com/DannyBen/snapcrawl/tree/v0.2.2) (2015-12-05)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.1...v0.2.2)
+
+## [v0.2.1](https://github.com/DannyBen/snapcrawl/tree/v0.2.1) (2015-12-05)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/v0.2.0...v0.2.1)
+
+## [v0.2.0](https://github.com/DannyBen/snapcrawl/tree/v0.2.0) (2015-12-05)
+
+[Full Changelog](https://github.com/DannyBen/snapcrawl/compare/0710e5f8d5e45b5341ae4a9fa2212d5c76c72de4...v0.2.0)

package/snapcrawl/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'byebug'
+  gem 'lp'
+  gem 'puma'
+  gem 'rspec'
+  gem 'rspec_approvals'
+  gem 'runfile'
+  gem 'runfile-tasks'
+  gem 'simplecov'
+  gem 'sinatra'
+end

package/snapcrawl/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Danny Ben Shitrit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/snapcrawl/README.md

@@ -0,0 +1,135 @@
+# Snapcrawl - crawl a website and take screenshots
+
+[![Gem Version](https://badge.fury.io/rb/snapcrawl.svg)](http://badge.fury.io/rb/snapcrawl)
+[![Build Status](https://github.com/DannyBen/snapcrawl/workflows/Test/badge.svg)](https://github.com/DannyBen/snapcrawl/actions?query=workflow%3ATest)
+[![Code Climate](https://codeclimate.com/github/DannyBen/snapcrawl/badges/gpa.svg)](https://codeclimate.com/github/DannyBen/snapcrawl)
+
+---
+
+Snapcrawl is a command line utility for crawling a website and saving
+screenshots. 
+
+
+## Features
+
+- Crawls a website to any given depth and saves screenshots
+- Can capture the full length of the page
+- Can use a specific resolution for screenshots
+- Skips capturing if the screenshot was already saved recently
+- Uses local caching to avoid expensive crawl operations if not needed
+- Reports broken links
+
+## Install
+
+**Using Docker**
+
+You can run Snapcrawl by using this docker image (which contains all the
+necessary prerequisites):
+
+```shell
+$ alias snapcrawl='docker run --rm -it --network host --volume "$PWD:/app" dannyben/snapcrawl'
+```
+
+For more information on the Docker image, refer to the [docker-snapcrawl][3] repository.
+
+**Using Ruby**
+
+```shell
+$ gem install snapcrawl
+```
+
+Note that Snapcrawl requires [PhantomJS][1] and [ImageMagick][2].
+
+## Usage
+
+Snapcrawl can be configured either through a configuration file (YAML), or by specifying options in the command line.
+
+```shell
+$ snapcrawl
+Usage:
+  snapcrawl URL [--config FILE] [SETTINGS...]
+  snapcrawl -h | --help
+  snapcrawl -v | --version
+```
+
+The default configuration filename is `snapcrawl.yml`.
+
+Using the `--config` flag will create a template configuration file if it is not present:
+
+```shell
+$ snapcrawl example.com --config snapcrawl
+```
+
+### Specifying options in the command line
+
+All configuration options can be specified in the command line as `key=value` pairs:
+
+```shell
+$ snapcrawl example.com log_level=0 depth=2 width=1024
+```
+
+### Sample configuration file
+
+```yaml
+# All values below are the default values
+
+# log level (0-4) 0=DEBUG 1=INFO 2=WARN 3=ERROR 4=FATAL
+log_level: 1
+
+# log_color (yes, no, auto)
+# yes  = always show log color
+# no   = never use colors
+# auto = only use colors when running in an interactive terminal
+log_color: auto
+
+# number of levels to crawl, 0 means capture only the root URL
+depth: 1
+
+# screenshot width in pixels
+width: 1280
+
+# screenshot height in pixels, 0 means the entire height
+height: 0
+
+# number of seconds to consider the page cache and its screenshot fresh
+cache_life: 86400
+
+# where to store the HTML page cache
+cache_dir: cache
+
+# where to store screenshots
+snaps_dir: snaps
+
+# screenshot filename template, where '%{url}' will be replaced with a 
+# slug version of the URL (no need to include the .png extension)
+name_template: '%{url}'
+
+# urls not matching this regular expression will be ignored
+url_whitelist: 
+
+# urls matching this regular expression will be ignored
+url_blacklist: 
+
+# take a screenshot of this CSS selector only
+css_selector: 
+
+# when true, ignore SSL related errors
+skip_ssl_verification: false
+
+# set to any number of seconds to wait for the page to load before taking
+# a screenshot, leave empty to not wait at all (only needed for pages with
+# animations or other post-load events).
+screenshot_delay: 
+```
+
+## Contributing / Support
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
+
+[1]: http://phantomjs.org/download.html
+[2]: https://imagemagick.org/script/download.php
+[3]: https://github.com/DannyBen/docker-snapcrawl
+[issues]: https://github.com/DannyBen/snapcrawl/issues
+

package/snapcrawl/Runfile

@@ -0,0 +1,35 @@
+require 'snapcrawl/version'
+
+title   'Snapcrawl Runfile'
+summary 'Runfile tasks for building the Snapcrawl gem'
+version Snapcrawl::VERSION
+
+import_gem 'runfile-tasks/gem'
+import 'debug'
+
+help   "Regenerate the command line output in the README file"
+action :patchme do
+  readme = File.read 'README.md'
+  usage  = `bundle exec snapcrawl -h`
+  usage.gsub!(/^/, "    ")
+  readme.gsub!(/(\$ snapcrawl --help)(.*)(---\s*)/m) { "#{$1}\n\n#{usage}\n#{$3}" }
+  File.write "README.md", readme
+end
+
+help   "Generate changelog and append old changelog"
+action :changelog do
+  system "git changelog --save"
+  # append older changelog (prior to switching to git-changelog)
+  system "cat .changelog.old.md >> CHANGELOG.md"
+end
+
+usage  "mockserver"
+help   "Start the mock server"
+action :mockserver do
+  Dir.chdir 'spec/server' do
+    system 'rackup -p 3000 -o 0.0.0.0'
+  end
+rescue Interrupt
+  abort "\rBye"
+end
+

package/snapcrawl/bin/snapcrawl

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'snapcrawl'
+require 'colsole'
+
+trap(:INT) { abort "\r\nGoodbye" }
+
+include Snapcrawl
+include Colsole
+
+begin
+  CLI.new.call ARGV
+rescue MissingPhantomJS => e
+  message = 'Cannot find phantomjs executable in the path, please install it first.'
+  say! "\n\nru`#{e.class}`\n#{message}"
+  exit 2
+rescue MissingImageMagick => e
+  message = 'Cannot find convert (ImageMagick) executable in the path, please install it first.'
+  say! "\n\nru`#{e.class}`\n#{message}"
+  exit 3
+rescue => e
+  puts e.backtrace.reverse if ENV['DEBUG']
+  say! "\nru`#{e.class}`\n#{e.message}"
+  exit 1
+end

package/snapcrawl/lib/snapcrawl/cli.rb

@@ -0,0 +1,52 @@
+require 'colsole'
+require 'docopt'
+require 'fileutils'
+
+module Snapcrawl
+  class CLI
+    include Colsole
+    using StringRefinements
+    using PairSplit
+
+    def call(args = [])
+      execute Docopt.docopt(docopt, version: VERSION, argv: args)
+    rescue Docopt::Exit => e
+      puts e.message
+    end
+
+  private
+
+    def execute(args)
+      config_file = args['--config']
+      Config.load config_file if config_file
+
+      tweaks = args['SETTINGS'].pair_split
+      apply_tweaks tweaks if tweaks
+
+      Dependencies.verify
+
+      $logger.debug 'initializing cli'
+      FileUtils.mkdir_p Config.snaps_dir
+
+      url = args['URL'].protocolize
+      crawler = Crawler.new url
+
+      crawler.crawl
+    end
+
+    def docopt
+      @docopt ||= File.read docopt_path
+    end
+
+    def docopt_path
+      File.expand_path 'templates/docopt.txt', __dir__
+    end
+
+    def apply_tweaks(tweaks)
+      tweaks.each do |key, value|
+        Config.settings[key] = value
+        $logger.level = value if key == 'log_level'
+      end
+    end
+  end
+end

package/snapcrawl/lib/snapcrawl/config.rb

@@ -0,0 +1,60 @@
+require 'sting'
+require 'fileutils'
+
+module Snapcrawl
+  class Config < Sting
+    class << self
+      def load(file = nil)
+        reset!
+        push defaults
+
+        return unless file
+
+        file = "#{file}.yml" unless /\.ya?ml$/.match?(file)
+
+        # FIXME: Cannot use logger here due to the "chicken and egg" with
+        #        Config. The $logger is available, but it was not yet fully
+        #        configured with log_level etc.
+        if File.exist? file
+          # $logger.debug "loading config file g`#{file}`"
+          push file
+        else
+          # $logger.debug "creating config file g`#{file}`"
+          create_config file
+        end
+      end
+
+    private
+
+      def defaults
+        {
+          depth:                 1,
+          width:                 1280,
+          height:                0,
+          cache_life:            86_400,
+          cache_dir:             'cache',
+          snaps_dir:             'snaps',
+          name_template:         '%{url}',
+          url_whitelist:         nil,
+          url_blacklist:         nil,
+          css_selector:          nil,
+          log_level:             1,
+          log_color:             'auto',
+          skip_ssl_verification: false,
+          screenshot_delay:      nil,
+        }
+      end
+
+      def create_config(file)
+        content = File.read config_template
+        dir = File.dirname file
+        FileUtils.mkdir_p dir
+        File.write file, content
+      end
+
+      def config_template
+        File.expand_path 'templates/config.yml', __dir__
+      end
+    end
+  end
+end

package/snapcrawl/lib/snapcrawl/crawler.rb

@@ -0,0 +1,98 @@
+require 'fileutils'
+
+module Snapcrawl
+  class Crawler
+    using StringRefinements
+
+    attr_reader :url
+
+    def initialize(url)
+      $logger.debug "initializing crawler with g`#{url}`"
+
+      config_for_display = Config.settings.dup
+      config_for_display['name_template'] = '%%{url}'
+
+      $logger.debug "config #{config_for_display}"
+      @url = url
+    end
+
+    def crawl
+      Dependencies.verify
+      todo[url] = Page.new url
+      process_todo while todo.any?
+    end
+
+  private
+
+    def process_todo
+      $logger.debug "processing queue: g`#{todo.count} remaining`"
+
+      url, page = todo.shift
+      done.push url
+
+      return unless process_page page
+
+      register_sub_pages page.pages if page.depth < Config.depth
+    end
+
+    def register_sub_pages(pages)
+      pages.each do |sub_page|
+        next if todo.has_key?(sub_page) || done.include?(sub_page)
+
+        if Config.url_whitelist && sub_page.path !~ (/#{Config.url_whitelist}/)
+          $logger.debug "ignoring mu`#{sub_page.url}`, reason: whitelist"
+          next
+        end
+
+        if Config.url_blacklist && sub_page.path =~ (/#{Config.url_blacklist}/)
+          $logger.debug "ignoring mu`#{sub_page.url}`, reason: blacklist"
+          next
+        end
+
+        todo[sub_page.url] = sub_page
+      end
+    end
+
+    def process_page(page)
+      outfile = "#{Config.snaps_dir}/#{Config.name_template}.png" % { url: page.url.to_slug }
+
+      $logger.info "processing mu`#{page.url}`, depth: #{page.depth}"
+
+      unless page.valid?
+        $logger.debug "page #{page.path} is invalid, aborting process"
+        return false
+      end
+
+      if file_fresh? outfile
+        $logger.info "screenshot for #{page.path} already exists"
+      else
+        $logger.info "gb`capturing screenshot for #{page.path}`"
+        save_screenshot page, outfile
+      end
+
+      true
+    end
+
+    def save_screenshot(page, outfile)
+      page.save_screenshot outfile
+    rescue => e
+      $logger.error "screenshot error on mu`#{page.path}` - r`#{e.class}`: #{e.message}"
+    end
+
+    def file_fresh?(file)
+      Config.cache_life.positive? and File.exist?(file) and file_age(file) < Config.cache_life
+    end
+
+    def file_age(file)
+      (Time.now - File.stat(file).mtime).to_i
+    end
+
+    def todo
+      @todo ||= {}
+    end
+
+    def done
+      @done ||= []
+    end
+  end
+end

package/snapcrawl/lib/snapcrawl/dependencies.rb

@@ -0,0 +1,21 @@
+require 'colsole'
+
+module Snapcrawl
+  class Dependencies
+    class << self
+      include Colsole
+
+      def verify
+        return if @verified
+
+        $logger.debug 'verifying g`phantomjs` is present'
+        raise MissingPhantomJS unless command_exist? 'phantomjs'
+
+        $logger.debug 'verifying g`imagemagick` is present'
+        raise MissingImageMagick unless command_exist? 'convert'
+
+        @verified = true
+      end
+    end
+  end
+end

package/snapcrawl/lib/snapcrawl/exceptions.rb

@@ -0,0 +1,5 @@
+module Snapcrawl
+  class MissingPhantomJS < StandardError; end
+  class MissingImageMagick < StandardError; end
+  class ScreenshotError < StandardError; end
+end

package/snapcrawl/lib/snapcrawl/log_helpers.rb

@@ -0,0 +1,36 @@
+require 'colsole'
+
+module Snapcrawl
+  module LogHelpers
+    include Colsole
+
+    SEVERITY_COLORS = {
+      'INFO'  => :b,
+      'WARN'  => :y,
+      'ERROR' => :r,
+      'FATAL' => :r,
+      'DEBUG' => :c,
+    }
+
+    def log_formatter
+      proc do |severity, _time, _prog, message|
+        severity_color = SEVERITY_COLORS[severity]
+        line = "#{severity_color}`#{severity.rjust 5}` : #{message}\n"
+        use_colors? ? colorize(line) : strip_colors(line)
+      end
+    end
+
+    def use_colors?
+      @use_colors ||= (Config.log_color == 'auto' ? tty? : Config.log_color)
+    end
+
+    def tty?
+      case ENV['TTY']
+      when 'on' then true
+      when 'off' then false
+      else
+        $stdout.tty?
+      end
+    end
+  end
+end