winsize 1.0.1 → 2.0.0

data/.gemspec.rb

@@ -0,0 +1,51 @@
+class Readme < String
+  attr_reader :path
+
+  def initialize(path)
+    @path = path
+    super(File.read(self.path))
+  end
+
+  def summary
+    if self =~ /^# (?:\S+)\s+(.+?)\s{2,}/m
+      scrub $1
+    else
+      raise "could not find summary in #{path}"
+    end
+  end
+
+  def description
+    if self =~ /^## Description\s+(.+?)\s{2,}/m
+      scrub $1
+    else
+      raise "could not find description in #{path}"
+    end
+  end
+
+  private
+    def scrub(string)
+      string.delete("\\`").gsub(/\[([^\]]+)\]\([^)]*\)/, "\\1").tr("\n", " ").to_s
+    end
+end
+
+class Files < Array
+  def executables
+    grep(%r{^bin/}) { |f| File.basename(f) }
+  end
+
+  def requires
+    ["lib"]
+  end
+
+  def tests
+    grep(%r{^(test|spec|features)/})
+  end
+end
+
+def files
+  @files ||= Files.new(`git ls-files`.split($/))
+end
+
+def readme(path = File.expand_path("./README.md"))
+  (@readmes ||= {})[path] ||= Readme.new(path)
+end

data/.gitignore

@@ -0,0 +1,5 @@
+/Gemfile.lock
+/lib/winsize.bundle
+/lib/winsize.so
+/pkg
+/tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest", :platform => :ruby_18

data/LICENSE

@@ -1,19 +1,22 @@
-Copyright (C) 2011 by Samuel Kadolph
+Copyright (c) 2012 Samuel Kadolph
 
-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:
+MIT License
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+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 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.
+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

@@ -1,72 +1,75 @@
-# ruby-winsize
+# ruby-winsize [![Build Status](https://secure.travis-ci.org/samuelkadolph/ruby-winsize.png?branch=master)](http://travis-ci.org/samuelkadolph/ruby-winsize)
 
-ruby-winsize is a small library that lets you get and set the winsize of a terminal.
+winsize is a small library that lets you get and set the winsize of a tty.
 
-ruby-winsize adds two methods (`winsize` and `winsize=`) to for use with any
-`IO` instance for a TTY device. The `Winsize::Winsize` class is an intermediate
-form that is used for `ioctl` calls to the TTY device.
+## Description
 
-## Installing
+winsize adds 2 methods: `winsize` and `winsize=` to `IO` that allows you to control the size of a tty window. Mainly used
+with `pty` to deal with executables that word wrap (i.e. `top`). *If you are using ruby 1.9.3 this gem is not needed.
+`require "io/console"` provides the same functionality.*
 
-### Recommended
+## Installation
 
-```
-gem install winsize
-```
+add this line your application's Gemfile:
 
-### Edge
+    gem "winsize"
 
-```
-git clone https://github.com/samuelkadolph/ruby-winsize
-cd ruby-winsize && rake install
-```
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install winsize
 
 ## Usage
 
-To get the size of the `$stdout` terminal.
+#### Get the size of the terminal
 
 ```ruby
 require "winsize"
 
-size = $stdout.winsize
-puts "Your terminal is #{size.columns}x#{size.rows}"
-puts "Your terminal is #{size.horizontal_pixels}px*#{size.vertical_pixels}px"
+rows, cols = $stdout.winsize
+puts "Your terminal is #{cols}x#{rows}"
 ```
 
-To set the size of a pty terminal.
-This is useful if you are running a subshell and want the subshell to have the
-same output size as the terminal you yourself are running in.
-
-You might think it would be useful to set the winsize of `$stdout` it actually
-isn't since the terminal is usually limited by the monitor size or the terminal
-application and increasing the size messes with trimming logic.
+#### Set the size of a pty terminal
 
 ```ruby
 require "pty"
 require "winsize"
 
-size = Winsize.new(32, 160)
-# or
-# size = $stdout.winsize
-
+size = Winsize.new(32, 180)
 input, output, pid = PTY.spawn
-
 output.winsize = size
-# or
-# output.winsize = 32, 160
 ```
 
-You may want to combine `winsize` and catching the [`SIGWINCH`](http://en.wikipedia.org/wiki/SIGWINCH) signal so you
-update something that your terminal has been resized.
+#### Reacting to a resized terminal
+
+You may want to combine `winsize` and catching the [`SIGWINCH`](http://en.wikipedia.org/wiki/SIGWINCH) signal so you can
+react when the terminal has been resized.
 
 ```ruby
 require "winsize"
 
-puts "Terminal size is #{$stdout.winsize.columns}x#{$stdout.winsize.rows}"
+puts "Terminal size is #{$stdout.winsize.cols}x#{$stdout.winsize.rows}"
 
-Signal.trap "WINCH" do
-  puts "Terminal resized to #{$stdout.winsize.columns}x#{$stdout.winsize.rows}"
+Signal.trap(:WINCH) do
+  puts "Terminal resized to #{$stdout.winsize.cols}x#{$stdout.winsize.rows}"
 end
 
 loop { sleep(10) }
-```
+```
+
+#### `io/console` API compatible
+
+```ruby
+require "winsize"
+
+$stdout.winsize.to_ary # => [32, 180]
+$stdout.winsize = [32, 180]
+```
+
+## Contributing
+
+Fork, branch & pull request.

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require "rake/testtask"
+
+Rake::ExtensionTask.new("winsize") do |task|
+  task.ext_dir = "ext"
+end
+
+Rake::TestTask.new do |task|
+  task.libs << "test"
+  task.test_files = Dir["test/**/*_test.rb"]
+  task.verbose = true
+end
+
+task :test => :compile

data/ext/winsize.c

@@ -1,9 +1,9 @@
-#include "ruby.h"
 #include <sys/ioctl.h>
+#include "ruby.h"
 
 void Init_winsize()
 {
-  VALUE rb_mWinSize = rb_define_module("Winsize");
-  rb_define_const(rb_mWinSize, "TIOCGWINSZ", ULONG2NUM(TIOCGWINSZ));
-  rb_define_const(rb_mWinSize, "TIOCSWINSZ", ULONG2NUM(TIOCSWINSZ));
+  VALUE rb_cWinSize = rb_define_class("Winsize", rb_cObject);
+  rb_define_const(rb_cWinSize, "TIOCGWINSZ", ULONG2NUM(TIOCGWINSZ));
+  rb_define_const(rb_cWinSize, "TIOCSWINSZ", ULONG2NUM(TIOCSWINSZ));
 }

data/lib/winsize.rb

@@ -1,26 +1,27 @@
-require "winsize.so"
-require "winsize/version"
+class Winsize
+  require "winsize.so"
+  require "winsize/version"
 
-module Winsize
-  class Winsize
-    attr_accessor :rows, :columns, :horizontal_pixels, :vertical_pixels
+  attr_accessor :rows, :columns, :horizontal_pixels, :vertical_pixels
+  alias cols columns
 
-    def initialize(rows, columns, horizontal_pixels = 0, vertical_pixels = 0)
-      @rows, @columns, @horizontal_pixels, @vertical_pixels = rows, columns, horizontal_pixels, vertical_pixels
-    end
+  def initialize(rows, columns, horizontal_pixels = 0, vertical_pixels = 0)
+    @rows, @columns, @horizontal_pixels, @vertical_pixels = rows, columns, horizontal_pixels, vertical_pixels
+  end
 
-    def [](index)
-      [rows, columns][index]
-    end
+  def [](index)
+    to_ary[index]
+  end
 
-    def to_ioctl
-      [rows, columns, horizontal_pixels, vertical_pixels].pack("SSSS")
-    end
+  def to_ary
+    [rows, columns, horizontal_pixels, vertical_pixels]
   end
 
-  module IOExtensions
-    # TIOCGWINSZ & TIOCSWINSZ are defined in ext/winsize.c
+  def to_ioctl
+    [rows, columns, horizontal_pixels, vertical_pixels].pack("SSSS")
+  end
 
+  module IOExtension
     def winsize
       size = ""
       ioctl(TIOCGWINSZ, size)
@@ -28,13 +29,12 @@ module Winsize
     end
 
     def winsize=(size)
-      size = Winsize.new(*size) unless size.respond_to?(:to_ioctl)
-      size = size.to_ioctl
+      size = size.respond_to?(:to_ioctl) ? size.to_ioctl : Winsize.new(*size).to_ioctl
       ioctl(TIOCSWINSZ, size)
     end
   end
 end
 
 class IO
-  include Winsize::IOExtensions
+  include Winsize::IOExtension
 end

data/lib/winsize/version.rb

@@ -1,3 +1,3 @@
-module WinSize
-  VERSION = "1.0.1"
+class Winsize
+  VERSION = "2.0.0"
 end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require "minitest/autorun"
+require "minitest/spec"
+require "winsize"

data/test/winsize_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+require "pty"
+
+describe Winsize do
+  it "should add winsize and winsize= to IO" do
+    $stdout.must_respond_to(:winsize)
+    $stdout.must_respond_to(:winsize=)
+
+    size = $stdout.winsize
+    size.rows.wont_be_nil
+    size.columns.wont_be_nil
+  end
+
+  it "should not work on non tty files" do
+    read, _ = IO.pipe
+    lambda { read.winsize }.must_raise(Errno::ENOTTY, Errno::EINVAL)
+    lambda { read.winsize = [10, 10] }.must_raise(Errno::ENOTTY, Errno::EINVAL)
+  end
+
+  it "should set the winsize on a pty" do
+    master, slave, pid = PTY.spawn
+    begin
+      size = Winsize.new(32, 180)
+      master.winsize = size
+      master.winsize.rows.must_equal(32)
+      master.winsize.columns.must_equal(180)
+    ensure
+      Process.kill(:KILL, pid)
+    end
+  end
+end

data/winsize.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path("../.gemspec", __FILE__)
+require File.expand_path("../lib/winsize/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "winsize"
+  spec.version       = Winsize::VERSION
+  spec.authors       = ["Samuel Kadolph"]
+  spec.email         = ["samuel@kadolph.com"]
+  spec.description   = readme.description
+  spec.summary       = readme.summary
+  spec.homepage      = "https://github.com/samuelkadolph/ruby-winsize"
+  spec.license       = "MIT"
+
+  spec.files         = files
+  spec.executables   = files.executables
+  spec.test_files    = files.tests
+  spec.require_paths = files.requires
+
+  spec.required_ruby_version = ">= 1.8.7"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winsize
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,26 +9,83 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-23 00:00:00.000000000Z
-dependencies: []
-description: ruby-winsize adds two methods (winsize and winsize=) to for use with
-  any IO instance for a TTY device. The Winsize::Winsize class is an intermediate
-  form that is used for ioctl calls to the TTY device.
+date: 2013-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'winsize adds 2 methods: winsize and winsize= to IO that allows you
+  to control the size of a tty window. Mainly used with pty to deal with executables
+  that word wrap (i.e. top). *If you are using ruby 1.9.3 this gem is not needed.
+  require "io/console" provides the same functionality.*'
 email:
 - samuel@kadolph.com
 executables: []
-extensions:
-- ext/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
+- .gemspec.rb
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
 - ext/extconf.rb
 - ext/winsize.c
-- lib/winsize/version.rb
 - lib/winsize.rb
-- LICENSE
-- README.md
+- lib/winsize/version.rb
+- test/test_helper.rb
+- test/winsize_test.rb
+- winsize.gemspec
 homepage: https://github.com/samuelkadolph/ruby-winsize
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -38,18 +95,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4587146050354108076
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Small library that adds methods for getting and setting the winsize of any
-  TTY IO object.
-test_files: []
+summary: ! '![Build Status](http://travis-ci.org/samuelkadolph/ruby-winsize)'
+test_files:
+- test/test_helper.rb
+- test/winsize_test.rb