tty-screen 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef837a96a0b6f7282a40e712920b73ffba5c9946899d13c0f1a9a74395b7c6fc
-  data.tar.gz: 3b58bc3f356329e71aeaf495e7b4dd0cfbe3390bd205d94791cc689abb224111
+  metadata.gz: 4e17bafe91486f49afff31f04968d8515502eb3065f3739a796f987bd0ffed96
+  data.tar.gz: 80112f9584cfc84a1c76eeeff88e08cac08853714c4d6e179aa92ad753bb9175
 SHA512:
-  metadata.gz: 5611619549f9eae4c34152768a263f999eb466106e36604ecc34c73934491f896942446efd31aa8e0229292738ad8feb9d7d7f8fd6d023c39267e9acdd26609f
-  data.tar.gz: 2a1129f3aa1c066271028c2da550aba4d267174b5e2354a6276a6c0a66acf926e83ba7cc89324cc842afaacdbd6036d6976815f644d6d0eb3a95c72fbed5c4e8
+  metadata.gz: c3a00a8c1cfa355c988f7999fdd2d3bd49b903cf7be4d3446cb50e8fa5bc8c17b96b9a6be7f329299ba0f6eb58a54744c2a64ccec9d9a3255498c02bbb37d876
+  data.tar.gz: 73a02084a05564198f93fc5bc09b1db6d2eb90d426fbc0ce0d93f965b487c240d5a5c303f651c8afacc6b688c0e0780a1bc0953c0d39fca534432d8aca8eaf44

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change log
 
+## [v0.8.0] - 2020-05-28
+
+### Added
+* Add #windows? platform check
+* Add #command_exist? to see if an executable exists before running it
+* Add performance tests
+
+### Changed
+* Change #jruby? method to hoist within module
+* Change #size_from_win_api to check only on windows platform and
+  hoist definition within module
+* Change #size_from_java to hoist within module
+* Change #size_from_ioctl to:
+  * check solaris-like system
+  * scan all streams to see if any attached to a terminal
+  * hoist definition within module
+* Change #size_from_io_console to perform check on JRuby as well
+* Change #size_from_readline to attempt to load readline gem
+* Change #run_command to execute command directly without sub shell or temp files
+
 ## [v0.7.1] - 2020-02-02
 
 ### Changed
@@ -111,6 +131,7 @@
 ### Fixed
 * Fix bug with screen detection from_io_console by @luxflux
 
+[v0.8.0]: https://github.com/piotrmurach/tty-screen/compare/v0.7.1...v0.8.0
 [v0.7.1]: https://github.com/piotrmurach/tty-screen/compare/v0.7.0...v0.7.1
 [v0.7.0]: https://github.com/piotrmurach/tty-screen/compare/v0.6.5...v0.7.0
 [v0.6.5]: https://github.com/piotrmurach/tty-screen/compare/v0.6.4...v0.6.5

data/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="tty logo" /></a>
 </div>
 
 # TTY::Screen [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
@@ -19,7 +19,7 @@
 [coverage]: https://coveralls.io/r/piotrmurach/tty-screen
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty-screen
 
-> Terminal screen size detection which works on Linux, OS X and Windows/Cygwin platforms and supports MRI, JRuby and Rubinius interpreters.
+> Terminal screen size detection which works on Linux, OS X and Windows/Cygwin platforms and supports MRI, JRuby, TruffleRuby and Rubinius interpreters.
 
 **TTY::Screen** provides independent terminal screen size detection component for [TTY](https://github.com/piotrmurach/tty) toolkit.
 

data/lib/tty/screen.rb

@@ -1,6 +1,11 @@
-# fronzen_string_literal: true
+# frozen_string_literal: true
 
-require_relative 'screen/version'
+begin
+  require "rbconfig"
+rescue LoadError
+end
+
+require_relative "screen/version"
 
 module TTY
   # Used for detecting screen properties
@@ -13,6 +18,22 @@ module TTY
       private_class_method(name)
     end
 
+    case (defined?(::RbConfig) ? ::RbConfig::CONFIG["host_os"] : ::RUBY_PLATFORM)
+    when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+      def windows?; true end
+    else
+      def windows?; false end
+    end
+    module_function :windows?
+
+    case (defined?(::RbConfig) ? ::RbConfig::CONFIG["ruby_install_name"] : ::RUBY_ENGINE)
+    when /jruby/
+      def jruby?; true end
+    else
+      def jruby?; false end
+    end
+    module_function :jruby?
+
     # Default terminal size
     #
     # @api public
@@ -22,10 +43,11 @@ module TTY
     @output = $stderr
 
     class << self
+      # Holds the environment variables
+      # @api public
       attr_accessor :env
 
       # Specifies an output stream
-      #
       # @api public
       attr_accessor :output
     end
@@ -33,20 +55,20 @@ module TTY
     # Get terminal rows and columns
     #
     # @return [Array[Integer, Integer]]
-    #   return rows & columns
+    #   return rows and columns
     #
     # @api public
-    def size
-      size = size_from_java
-      size ||= size_from_win_api
-      size ||= size_from_ioctl
-      size ||= size_from_io_console
-      size ||= size_from_readline
-      size ||= size_from_tput
-      size ||= size_from_stty
-      size ||= size_from_env
-      size ||= size_from_ansicon
-      size ||  DEFAULT_SIZE
+    def size(verbose: false)
+      size_from_java(verbose: verbose) ||
+      size_from_win_api(verbose: verbose) ||
+      size_from_ioctl ||
+      size_from_io_console(verbose: verbose) ||
+      size_from_readline(verbose: verbose) ||
+      size_from_tput ||
+      size_from_stty ||
+      size_from_env ||
+      size_from_ansicon ||
+      size_from_default
     end
     module_function :size
 
@@ -70,35 +92,49 @@ module TTY
     module_function :rows
     module_function :lines
 
-    STDOUT_HANDLE = 0xFFFFFFF5
+    # Default size for the terminal
+    #
+    # @return [Array[Integer, Integer]]
+    #
+    # @api private
+    def size_from_default
+      DEFAULT_SIZE
+    end
+    module_function :size_from_default
 
     # Determine terminal size with a Windows native API
     #
     # @return [nil, Array[Integer, Integer]]
     #
     # @api private
-    def size_from_win_api(verbose: nil)
-      require 'fiddle'
-
-      kernel32 = Fiddle::Handle.new('kernel32')
-      get_std_handle = Fiddle::Function.new(kernel32['GetStdHandle'],
-                        [-Fiddle::TYPE_INT], Fiddle::TYPE_INT)
-      get_console_buffer_info = Fiddle::Function.new(
-        kernel32['GetConsoleScreenBufferInfo'],
-        [Fiddle::TYPE_LONG, Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
-
-      format        = 'SSSSSssssSS'
-      buffer        = ([0] * format.size).pack(format)
-      stdout_handle = get_std_handle.(STDOUT_HANDLE)
-
-      get_console_buffer_info.(stdout_handle, buffer)
-      _, _, _, _, _, left, top, right, bottom, = buffer.unpack(format)
-      size = [bottom - top + 1, right - left + 1]
-      return size if nonzero_column?(size[1] - 1)
-    rescue LoadError
-      warn 'no native fiddle module found' if verbose
-    rescue Fiddle::DLError
-      # non windows platform or no kernel32 lib
+    if windows?
+      STDOUT_HANDLE = 0xFFFFFFF5
+
+      def size_from_win_api(verbose: false)
+        require "fiddle" unless defined?(Fiddle)
+
+        kernel32 = Fiddle::Handle.new("kernel32")
+        get_std_handle = Fiddle::Function.new(kernel32["GetStdHandle"],
+                          [-Fiddle::TYPE_INT], Fiddle::TYPE_INT)
+        get_console_buffer_info = Fiddle::Function.new(
+          kernel32["GetConsoleScreenBufferInfo"],
+          [Fiddle::TYPE_LONG, Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
+
+        format        = "SSSSSssssSS"
+        buffer        = ([0] * format.size).pack(format)
+        stdout_handle = get_std_handle.(STDOUT_HANDLE)
+
+        get_console_buffer_info.(stdout_handle, buffer)
+        _, _, _, _, _, left, top, right, bottom, = buffer.unpack(format)
+        size = [bottom - top + 1, right - left + 1]
+        return size if nonzero_column?(size[1] - 1)
+      rescue LoadError
+        warn "no native fiddle module found" if verbose
+      rescue Fiddle::DLError
+        # non windows platform or no kernel32 lib
+      end
+    else
+      def size_from_win_api(verbose: false); nil end
     end
     module_function :size_from_win_api
 
@@ -107,15 +143,19 @@ module TTY
     # @return [nil, Array[Integer, Integer]]
     #
     # @api private
-    def size_from_java(verbose: nil)
-      return unless jruby?
-      require 'java'
-      java_import 'jline.TerminalFactory'
-      terminal = TerminalFactory.get
-      size = [terminal.get_height, terminal.get_width]
-      return size if nonzero_column?(size[1])
-    rescue
-      warn 'failed to import java terminal package' if verbose
+    if jruby?
+      def size_from_java(verbose: false)
+        require "java"
+
+        java_import "jline.TerminalFactory"
+        terminal = TerminalFactory.get
+        size = [terminal.get_height, terminal.get_width]
+        return size if nonzero_column?(size[1])
+      rescue
+        warn "failed to import java terminal package" if verbose
+      end
+    else
+      def size_from_java(verbose: false); nil end
     end
     module_function :size_from_java
 
@@ -128,62 +168,75 @@ module TTY
     # @return [nil, Array[Integer, Integer]]
     #
     # @api private
-    def size_from_io_console(verbose: nil)
-      return if jruby?
-      require 'io/console'
-
-      begin
-        if @output.tty? && IO.method_defined?(:winsize)
-          size = @output.winsize
-          size if nonzero_column?(size[1])
-        end
-      rescue Errno::EOPNOTSUPP
-        # no support for winsize on output
-      end
+    def size_from_io_console(verbose: false)
+      require "io/console" unless IO.method_defined?(:winsize)
+
+      return unless @output.tty? && @output.respond_to?(:winsize)
+
+      size = @output.winsize
+      size if nonzero_column?(size[1])
+    rescue Errno::EOPNOTSUPP
+      # no support for winsize on output
     rescue LoadError
-      warn 'no native io/console support or io-console gem' if verbose
+      warn "no native io/console support or io-console gem" if verbose
     end
     module_function :size_from_io_console
 
-    TIOCGWINSZ = 0x5413
-    TIOCGWINSZ_PPC = 0x40087468
+    if !jruby? && @output.respond_to?(:ioctl)
+      TIOCGWINSZ = 0x5413 # linux
+      TIOCGWINSZ_PPC = 0x40087468 # macos, freedbsd, netbsd, openbsd
+      TIOCGWINSZ_SOL = 0x5468 # solaris
 
-    # Read terminal size from Unix ioctl
-    #
-    # @return [nil, Array[Integer, Integer]]
-    #
-    # @api private
-    def size_from_ioctl
-      return if jruby?
-      return unless @output.respond_to?(:ioctl)
-
-      format = 'SSSS'
-      buffer = ([0] * format.size).pack(format)
-      if ioctl?(TIOCGWINSZ, buffer) || ioctl?(TIOCGWINSZ_PPC, buffer)
-        rows, cols, = buffer.unpack(format)[0..1]
-        return [rows, cols] if nonzero_column?(cols)
+      # Read terminal size from Unix ioctl
+      #
+      # @return [nil, Array[Integer, Integer]]
+      #
+      # @api private
+      def size_from_ioctl
+        format = "SSSS"
+        buffer = ([0] * format.size).pack(format)
+
+        if ioctl?(TIOCGWINSZ, buffer) ||
+           ioctl?(TIOCGWINSZ_PPC, buffer) ||
+           ioctl?(TIOCGWINSZ_SOL, buffer)
+
+          rows, cols, = buffer.unpack(format)[0..1]
+          return [rows, cols] if nonzero_column?(cols)
+        end
       end
-    end
-    module_function :size_from_ioctl
 
-    # Check if ioctl can be called and the device is attached to terminal
-    #
-    # @api private
-    def ioctl?(control, buf)
-      @output.ioctl(control, buf) >= 0
-    rescue SystemCallError
-      false
+      # Check if ioctl can be called and any of the streams is
+      # attached to a terminal.
+      #
+      # @return [Boolean]
+      #   True if any of the streams is attached to a terminal, false otherwise.
+      #
+      # @api private
+      def ioctl?(control, buf)
+        ($stdout.ioctl(control, buf) >= 0) ||
+          ($stdin.ioctl(control, buf) >= 0) ||
+          ($stderr.ioctl(control, buf) >= 0)
+      rescue SystemCallError
+        false
+      end
+      module_function :ioctl?
+    else
+      def size_from_ioctl; nil end
     end
-    module_function :ioctl?
+    module_function :size_from_ioctl
 
     # Detect screen size using Readline
     #
     # @api private
-    def size_from_readline
-      if defined?(Readline) && Readline.respond_to?(:get_screen_size)
-        size = Readline.get_screen_size
-        size if nonzero_column?(size[1])
-      end
+    def size_from_readline(verbose: false)
+      require "readline" unless defined?(::Readline)
+
+      return unless ::Readline.respond_to?(:get_screen_size)
+
+      size = ::Readline.get_screen_size
+      size if nonzero_column?(size[1])
+    rescue LoadError
+      warn "no readline gem" if verbose
     rescue NotImplementedError
     end
     module_function :size_from_readline
@@ -192,11 +245,13 @@ module TTY
     #
     # @api private
     def size_from_tput
-      return unless @output.tty?
-      lines = run_command('tput', 'lines').to_i
-      cols  = run_command('tput', 'cols').to_i
-      [lines, cols] if nonzero_column?(lines)
-    rescue IOError, SystemCallError
+      return unless @output.tty? && command_exist?("tput")
+
+      lines = run_command("tput", "lines")
+      return unless lines
+
+      cols = run_command("tput", "cols")
+      [lines.to_i, cols.to_i] if nonzero_column?(lines)
     end
     module_function :size_from_tput
 
@@ -204,12 +259,13 @@ module TTY
     #
     # @api private
     def size_from_stty
-      return unless @output.tty?
-      out = run_command('stty', 'size')
+      return unless @output.tty? && command_exist?("stty")
+
+      out = run_command("stty", "size")
       return unless out
+
       size = out.split.map(&:to_i)
       size if nonzero_column?(size[1])
-    rescue IOError, SystemCallError
     end
     module_function :size_from_stty
 
@@ -224,8 +280,9 @@ module TTY
     #
     # @api private
     def size_from_env
-      return unless @env['COLUMNS'] =~ /^\d+$/
-      size = [(@env['LINES'] || @env['ROWS']).to_i, @env['COLUMNS'].to_i]
+      return unless @env["COLUMNS"] =~ /^\d+$/
+
+      size = [(@env["LINES"] || @env["ROWS"]).to_i, @env["COLUMNS"].to_i]
       size if nonzero_column?(size[1])
     end
     module_function :size_from_env
@@ -234,24 +291,34 @@ module TTY
     #
     # @api private
     def size_from_ansicon
-      return unless @env['ANSICON'] =~ /\((.*)x(.*)\)/
+      return unless @env["ANSICON"] =~ /\((.*)x(.*)\)/
+
       size = [$2, $1].map(&:to_i)
       size if nonzero_column?(size[1])
     end
     module_function :size_from_ansicon
 
+    # Check if command exists
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def command_exist?(command)
+      exts = env.fetch("PATHEXT", "").split(::File::PATH_SEPARATOR)
+      env.fetch("PATH", "").split(File::PATH_SEPARATOR).any? do |dir|
+        file = ::File.join(dir, command)
+        ::File.exist?(file) || exts.any? { |ext| ::File.exist?("#{file}#{ext}") }
+      end
+    end
+    private_module_function :command_exist?
+
     # Runs command silently capturing the output
     #
     # @api private
     def run_command(*args)
-      require 'tempfile'
-      out = Tempfile.new('tty-screen')
-      result = system(*args, out: out.path, err: File::NULL)
-      return if result.nil?
-      out.rewind
-      out.read
-    ensure
-      out.close if out
+      %x(#{args.join(" ")})
+    rescue IOError, SystemCallError
+      nil
     end
     private_module_function :run_command
 
@@ -264,10 +331,5 @@ module TTY
       column.to_i > 0
     end
     private_module_function :nonzero_column?
-
-    def jruby?
-      RbConfig::CONFIG['ruby_install_name'] == 'jruby'
-    end
-    private_module_function :jruby?
   end # Screen
 end # TTY

data/lib/tty/screen/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Screen
-    VERSION = "0.7.1"
+    VERSION = "0.8.0"
   end # Screen
 end # TTY

metadata

@@ -1,17 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: tty-screen
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
-dependencies: []
+date: 2020-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: Terminal screen size detection which works on Linux, OS X and Windows/Cygwin
-  platforms and supports MRI, JRuby and Rubinius interpreters.
+  platforms and supports MRI, JRuby, TruffleRuby and Rubinius interpreters.
 email:
 - piotr@piotrmurach.com
 executables: []
@@ -19,6 +47,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
@@ -55,5 +84,5 @@ rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Terminal screen size detection which works on Linux, OS X and Windows/Cygwin
-  platforms and supports MRI, JRuby and Rubinius interpreters.
+  platforms and supports MRI, JRuby, TruffleRuby and Rubinius interpreters.
 test_files: []