tty-screen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 163de431d1fd75a5a29b5d24ef67d3b40ec6a5a4
+  data.tar.gz: 868f17e7ac67424a1b6dd28b8f432401035cbf72
+SHA512:
+  metadata.gz: d60be14e99f7a97bb5abc5635e873e43f53713d3e286bb02fce9f810acccbb1089d94e9b64c138945fa97e38d20516e6d7ca3f9c08453573a9fe4712b364cd1a
+  data.tar.gz: a777e4b0edc978eaa22616d00baeb26643c594714ceeb79ebc755aa4fd5a24e9eed60a420118599db286105addd00e703beaca1e9b08ff9d3b71e859da40daf6

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+bundler_args: --without yard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+matrix:
+  include:
+    - rvm: jruby-19mode
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+    - rvm: jruby-head
+    - rvm: rbx-2
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+  fast_finish: true
+branches:
+  only: master

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake',    '~> 10.3.2'
+  gem 'rspec',   '~> 3.1.0'
+  gem 'yard',    '~> 0.8.7'
+  gem 'timecop', '~> 0.7.1'
+  gem 'pastel',  '~> 0.3.0'
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.7.0'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.9'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotr Murach
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,60 @@
+# TTY::Screen
+[![Gem Version](https://badge.fury.io/rb/tty-screen.png)][gem]
+[![Build Status](https://secure.travis-ci.org/peter-murach/tty-screen.png?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/peter-murach/tty-screen.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/peter-murach/tty-screen/badge.png)][coverage]
+
+[gem]: http://badge.fury.io/rb/tty-screen
+[travis]: http://travis-ci.org/peter-murach/tty-screen
+[codeclimate]: https://codeclimate.com/github/peter-murach/tty-screen
+[coverage]: https://coveralls.io/r/peter-murach/tty-screen
+
+> Terminal screen size detection which works both on Linux, OS X and Windows/Cygwin platforms and supports MRI, JRuby and Rubinius interpreters.
+
+**TTY::Screen** provides independent screen size detection component for [TTY](https://github.com/peter-murach/tty) toolkit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-screen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-screen
+
+## 1. Usage
+
+**TTY::Screen** allows you to detect terminal screen size by calling `size` method which returns [height, width] tuple.
+
+```ruby
+screen = TTY::Screen.new
+
+screen.size     # => [51, 280]
+screen.width    # => 280
+screen.height   # => 51
+```
+
+You can also use above methods as class instance methods:
+
+```ruby
+TTY::Screen.size  # => [51, 280]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tty-screen/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+
+Copyright (c) 2014 Piotr Murach. See LICENSE for further details.

data/Rakefile

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

data/lib/tty-screen.rb

@@ -0,0 +1,3 @@
+# coding: utf-8
+
+require 'tty/screen'

data/lib/tty/screen.rb

@@ -0,0 +1,154 @@
+# coding: utf-8
+
+require 'tty/screen/version'
+
+module TTY
+  # Used for detecting screen properties
+  #
+  # @api public
+  class Screen
+    # Specifies an output stream object
+    #
+    # @api public
+    attr_reader :output
+
+    # Create terminal screen
+    #
+    # @param [Hash] options
+    # @option options [Object] :output
+    #   the object that responds to print call defaulting to stderr
+    #
+    # @api public
+    def initialize(options = {})
+      @output = options.fetch(:output) { $stderr }
+    end
+
+    def self.size
+      @size ||= new.size
+    end
+
+    def self.width
+      size[1]
+    end
+
+    def self.height
+      size[0]
+    end
+
+    # Get terminal rows and columns
+    #
+    # @return [Array[Integer, Integer]]
+    #   return rows & columns
+    #
+    # @api public
+    def size
+      @size ||= begin
+        size = from_io_console
+        size ||= from_readline
+        size ||= from_tput
+        size ||= from_stty
+        size ||= from_env
+        size ||= from_ansicon
+        size || default_size
+      end
+    end
+
+    # Default terminal size
+    #
+    # @api public
+    def default_size
+      [27, 80]
+    end
+
+    def height
+      size[0]
+    end
+    alias_method :rows, :height
+
+    def width
+      size[1]
+    end
+    alias_method :columns, :width
+
+    # Detect screen size by loading io/console lib
+    #
+    # @return [Array[Integer, Integer]]
+    #
+    # @api private
+    def from_io_console
+      return if jruby?
+      Kernel.require 'io/console'
+      size = IO.console.winsize
+      size if nonzero_column?(size[1])
+    rescue LoadError
+      # Didn't find io/console in stdlib
+    end
+
+    # Detect screen size using Readline
+    #
+    #
+    # @api private
+    def from_readline
+      return unless defined?(Readline)
+      size = Readline.get_screen_size
+      size if nonzero_column?(size[1])
+    rescue NotImplementedError
+    end
+
+    # Detect terminal size from tput utility
+    #
+    # @api public
+    def 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 Errno::ENOENT
+    end
+
+    # Detect terminal size from stty utility
+    #
+    # @api public
+    def from_stty
+      return unless output.tty?
+      size = run_command('stty', 'size').split.map(&:to_i)
+      size if nonzero_column?(size[1])
+    rescue Errno::ENOENT
+    end
+
+    # Detect terminal size from environment
+    #
+    # @api private
+    def from_env
+      return unless ENV['COLUMNS'] =~ /^\d+$/
+      size = [(ENV['LINES'] || ENV['ROWS']).to_i, ENV['COLUMNS'].to_i]
+      size if nonzero_column?(size[1])
+    end
+
+    # Detect terminal size on windows
+    #
+    # @api private
+    def from_ansicon
+      return unless ENV['ANSICON'] =~ /\((.*)x(.*)\)/
+      size = [$2, $1].map(&:to_i)
+      size if nonzero_column?(size[1])
+    end
+
+    # Runs command in subprocess
+    #
+    # @api public
+    def run_command(command, name)
+      `#{command} #{name} 2>/dev/null`
+    end
+
+    private
+
+    def nonzero_column?(column)
+      column.to_i > 0
+    end
+
+    def jruby?
+      RbConfig::CONFIG['ruby_install_name'] == 'jruby'
+    end
+  end # Screen
+end # TTY

data/lib/tty/screen/version.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+module TTY
+  class Screen
+    VERSION = "0.1.0"
+  end # Screen
+end # TTY

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# 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 'tty-screen'
+
+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/size_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+RSpec.describe TTY::Screen, '.size' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  subject(:screen) { described_class.new(output: output) }
+
+  context 'size' do
+    it "correctly falls through choices" do
+      allow(screen).to receive(:from_io_console).and_return([51, 280])
+      allow(screen).to receive(:from_readline).and_return(nil)
+      expect(screen.size).to eq([51, 280])
+      expect(screen).to_not have_received(:from_readline)
+      expect(screen.width).to eq(280)
+      expect(screen.height).to eq(51)
+    end
+
+    it "allows to call size as class instance" do
+      screen = double(:screen, size: [51, 280])
+      allow(TTY::Screen).to receive(:new).and_return(screen)
+      expect(TTY::Screen.size).to eq([51, 280])
+      expect(TTY::Screen.size).to eq([51, 280])
+      expect(TTY::Screen.width).to eq(280)
+      expect(TTY::Screen.height).to eq(51)
+      expect(TTY::Screen).to have_received(:new).once
+    end
+  end
+
+  context 'from io console' do
+    it "doesn't calculate size if jruby " do
+      allow(screen).to receive(:jruby?).and_return(true)
+      expect(screen.from_io_console).to eq(nil)
+    end
+
+    it "doesn't calculate size if io/console not available" do
+      allow(screen).to receive(:jruby?).and_return(false)
+      allow(Kernel).to receive(:require).with('io/console').and_raise(LoadError)
+      expect(screen.from_io_console).to eq(nil)
+    end
+  end
+
+  context 'from tput' do
+    it "doesn't run command if outside of terminal" do
+      allow(output).to receive(:tty?).and_return(false)
+      expect(screen.from_tput).to eq(nil)
+    end
+
+    it "runs tput commands" do
+      allow(output).to receive(:tty?).and_return(true)
+      allow(screen).to receive(:run_command).with('tput', 'lines').and_return(51)
+      allow(screen).to receive(:run_command).with('tput', 'cols').and_return(280)
+      expect(screen.from_tput).to eq([51, 280])
+    end
+
+    it "doesn't return zero size" do
+      allow(output).to receive(:tty?).and_return(true)
+      allow(screen).to receive(:run_command).with('tput', 'lines').and_return(0)
+      allow(screen).to receive(:run_command).with('tput', 'cols').and_return(0)
+      expect(screen.from_tput).to eq(nil)
+    end
+  end
+
+  context 'from stty' do
+    it "doesn't run command if outside of terminal" do
+      allow(output).to receive(:tty?).and_return(false)
+      expect(screen.from_stty).to eq(nil)
+    end
+
+    it "runs stty commands" do
+      allow(output).to receive(:tty?).and_return(true)
+      allow(screen).to receive(:run_command).with('stty', 'size').and_return("51 280")
+      expect(screen.from_stty).to eq([51, 280])
+    end
+
+    it "doesn't return zero size" do
+      allow(output).to receive(:tty?).and_return(true)
+      allow(screen).to receive(:run_command).with('stty', 'size').and_return("0 0")
+      expect(screen.from_stty).to eq(nil)
+    end
+  end
+
+  context 'from env' do
+    it "doesn't calculate size without COLUMNS key" do
+      allow(ENV).to receive(:[]).with('COLUMNS').and_return nil
+      expect(screen.from_env).to eq(nil)
+    end
+
+    it "extracts lines and columns from environment" do
+      allow(ENV).to receive(:[]).with('COLUMNS').and_return("280")
+      allow(ENV).to receive(:[]).with('LINES').and_return("51")
+      expect(screen.from_env).to eq([51, 280])
+    end
+
+    it "doesn't return zero size" do
+      allow(ENV).to receive(:[]).with('COLUMNS').and_return("0")
+      allow(ENV).to receive(:[]).with('LINES').and_return("0")
+      expect(screen.from_env).to eq(nil)
+    end
+  end
+
+  context 'from ansicon' do
+    it "doesn't calculate size without ANSICON key" do
+      allow(ENV).to receive(:[]).with('ANSICON').and_return nil
+      expect(screen.from_ansicon).to eq(nil)
+    end
+
+    it "extracts lines and columns from environment" do
+      allow(ENV).to receive(:[]).with('ANSICON').and_return("(280x51)")
+      expect(screen.from_ansicon).to eq([51, 280])
+    end
+
+    it "doesn't return zero size" do
+      allow(ENV).to receive(:[]).with('ANSICON').and_return("(0x0)")
+      expect(screen.from_ansicon).to eq(nil)
+    end
+  end
+end

data/tasks/console.rake

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-screen')
+  ARGV.clear
+  IRB.start
+end

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,29 @@
+# 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-screen.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/screen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-screen"
+  spec.version       = TTY::Screen::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+  spec.summary       = %q{Terminal screen size detection which works both on Linux, OS X and Windows/Cygwin platforms and supports MRI, JRuby and Rubinius interpreters.}
+  spec.description   = %q{Terminal screen size detection which works both on Linux, OS X and Windows/Cygwin platforms and supports MRI, JRuby and Rubinius interpreters.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: tty-screen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Terminal screen size detection which works both on Linux, OS X and Windows/Cygwin
+  platforms and supports MRI, JRuby and Rubinius interpreters.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tty-screen.rb
+- lib/tty/screen.rb
+- lib/tty/screen/version.rb
+- spec/spec_helper.rb
+- spec/unit/size_spec.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-screen.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Terminal screen size detection which works both on Linux, OS X and Windows/Cygwin
+  platforms and supports MRI, JRuby and Rubinius interpreters.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/size_spec.rb
+has_rdoc: