tty-pager 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f49536d3b9e164578f6d5ad3b561eacc9c2d6115
-  data.tar.gz: d5db6acf71e24ae57853b0623f49c18f0b05aedc
+  metadata.gz: e2c1947e24364321ab077aa4a9426654ecba831c
+  data.tar.gz: 86a316d617688d3e644802748ab991bd599eb8fd
 SHA512:
-  metadata.gz: f5c1a7349501d0ab69a3b626356e9c81af6af26c52e44d0fae16f0612e203ac649dec918b99e06dff930ec145acdd90db54a55d228f6648c2961053551d70c29
-  data.tar.gz: d6b107adf86a78772c73012e1f28c61c482a470d9fd90a46706bb92e8ca3cece43a90d19c8d86fadec66ebedc8d803ec0ee5d57615f20e607e3b35548c542074
+  metadata.gz: 5d4a40162a5d370d66f70f6967e21b088ca09e7fc4b213d9b190e169b1111cf8cf2d37d0db421ad39372629f1213814ad6b6ceb524ee06a3c360bb6bee2865a2
+  data.tar.gz: 9258e5ecba6052965b5336a932e38140c6bcb64d8ceffb8220ca73d131f331ab1752ac6a3b82ee29a6fece8cbc960036dd1501abc955563bbeb84999e92d66a7

data/.travis.yml

@@ -12,14 +12,12 @@ rvm:
   - 2.3.3
   - 2.4.1
   - ruby-head
-  - jruby-9000
+  - jruby-9.1.5.0
   - jruby-head
-  - rbx-3
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-3
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## [v0.9.0] - 2017-08-18
+
+### Changed
+* Change SystemPager to stop using fork, instead execute pager in subprocess
+  and make it portable across platforms including Windows
+* Change SystemPager to work on jruby
+* Change NullPager to only print to stdout on tty device
+* Change Pager to select SystemPager when paging command exists
+* Remove jruby? checks from pager selection
+
 ## [v0.8.0] - 2017-07-14
 
 ### Added
@@ -52,6 +62,9 @@
 ### Changed
 * Change SystemPager to correctly paginate inside a process.
 
+[v0.9.0]: https://github.com/peter-murach/tty-prompt/compare/v0.8.0...v0.9.0
+[v0.8.0]: https://github.com/peter-murach/tty-prompt/compare/v0.7.1...v0.8.0
+[v0.7.1]: https://github.com/peter-murach/tty-prompt/compare/v0.7.0...v0.7.1
 [v0.7.0]: https://github.com/peter-murach/tty-prompt/compare/v0.6.0...v0.7.0
 [v0.6.0]: https://github.com/peter-murach/tty-prompt/compare/v0.5.0...v0.6.0
 [v0.5.0]: https://github.com/peter-murach/tty-prompt/compare/v0.4.0...v0.5.0

data/README.md

@@ -35,7 +35,7 @@ Or install it yourself as:
 
 ## Overview
 
-The **TTY::Pager** on initialization will choose the best available pager out of `SystemPager`, `BasicPager` or `NullPager`. If paging is disabled then a `NullPager` is used and content is simply printed out to stdout, otherwise a check is performed to find system executable to perform pagination natively with `SystemPager`. However, if no system executable is found, a `BasicPager` is used which is a pure Ruby implementation that will work with any ruby interpreter.
+The **TTY::Pager** on initialization will choose the best available pager out of `SystemPager`, `BasicPager` or `NullPager`. If paging is disabled then a `NullPager` is used, which either returns text as is or simply prints it out to stdout on tty devices. Otherwise a check is performed to find paging command to page text with `SystemPager`. However, if no paging command is found, a `BasicPager` is used which is a pure Ruby implementation that is guaranteed to work with any ruby interpreter and any platform.
 
 ## 1. Usage
 

data/appveyor.yml

@@ -18,6 +18,8 @@ environment:
     - ruby_version: "22-x64"
     - ruby_version: "23"
     - ruby_version: "23-x64"
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
 matrix:
   allow_failures:
     - ruby_version: "193"

data/lib/tty/pager.rb

@@ -84,26 +84,19 @@ module TTY
     #
     # If the user disabled paging then a NullPager is returned,
     # otherwise a check is performed to find native system
-    # utility to perform pagination with SystemPager. Finally,
-    # if no system utility exists a BasicPager is used which
-    # is pure Ruby implementation.
+    # command to perform pagination with SystemPager. Finally,
+    # if no system command is found, a BasicPager is used which
+    # is a pure Ruby implementation known to work on any platform.
     #
     # @api private
     def find_available(options)
       if !enabled?
         NullPager.new
-      elsif !Pager.jruby? && SystemPager.can?
+      elsif SystemPager.available?
         SystemPager.new(options)
       else
         BasicPager.new(options)
       end
     end
-
-    # Check if running on jruby
-    #
-    # @api private
-    def self.jruby?
-      RbConfig::CONFIG['ruby_install_name'] == 'jruby'
-    end
   end # Pager
 end # TTY

data/lib/tty/pager/basic.rb

@@ -1,5 +1,5 @@
+# encoding: utf-8
 # frozen_string_literal: true
-# coding: utf-8
 
 require 'verse'
 

data/lib/tty/pager/null.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Pager
@@ -7,6 +8,8 @@ module TTY
       #
       # @api public
       def page(text, &callback)
+        return text unless output.tty?
+
         output.puts(text)
       end
     end

data/lib/tty/pager/system.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require 'tty-which'
 
@@ -19,9 +20,11 @@ module TTY
       def initialize(options = {})
         super
         @pager_command = options[:command]
-        unless self.class.can?
+        unless self.class.available?
           raise TTY::Pager::Error, "#{self.class.name} cannot be used on your" \
-                                   " system. Try using BasicPager instead."
+                                   " system due to lack of appropriate pager" \
+                                   " executable. Install `less` like pager or" \
+                                   " try using `BasicPager` instead." \
         end
       end
 
@@ -60,28 +63,6 @@ module TTY
         !available(*commands).nil?
       end
 
-      # Check if fork is supported
-      #
-      # @return [Boolean]
-      #
-      # @api public
-      def self.fork?
-        pid = fork {}
-        exit unless pid
-        true
-      rescue NotImplementedError
-        false
-      end
-
-      # Check if fork & comman exist
-      #
-      # @return [Boolean]
-      #
-      # @api public
-      def self.can?
-        self.fork? && self.available?
-      end
-
       # Use system command to page output text
       #
       # @example
@@ -95,29 +76,19 @@ module TTY
       #
       # @api public
       def page(text, &callback)
-        read_io, write_io = IO.pipe
+        return text unless output.tty?
 
-        pid = fork do
-          write_io.close
-          input.reopen(read_io)
-          read_io.close
+        write_io = open("|#{pager_command}", 'w')
+        pid      = write_io.pid
 
-          # Wait until we have input before we start the pager
-          IO.select [input]
-
-          begin
-            exec(pager_command)
-          rescue SystemCallError
-            exit 1
-          end
-        end
-
-        read_io.close
         write_io.write(text)
         write_io.close
 
-        _, status = Process.waitpid2(pid)
+        _, status = Process.waitpid2(pid, Process::WNOHANG)
         status.success?
+      rescue Errno::ECHILD
+        # on jruby 9x waiting on pid raises
+        true
       end
 
       private

data/lib/tty/pager/version.rb

@@ -1,7 +1,7 @@
-# coding: utf-8
+# encoding: utf-8
 
 module TTY
   class Pager
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end # Pager
 end # TTY

data/spec/unit/null/page_spec.rb

@@ -3,10 +3,21 @@
 RSpec.describe TTY::Pager::NullPager, '.page' do
   let(:output)   { StringIO.new }
 
-  it "doesn't paginate empty string" do
+  it "prints content to stdout when tty device" do
+    allow(output).to receive(:tty?).and_return(true)
     pager = described_class.new(output: output)
     text = "I try all things, I achieve what I can.\n"
+
     pager.page(text)
+
     expect(output.string).to eq(text)
   end
+
+  it "returns text when non-tty device" do
+    pager = described_class.new(output: output)
+    text = "I try all things, I achieve what I can.\n"
+
+    expect(pager.page(text)).to eq(text)
+    expect(output.string).to eq('')
+  end
 end

data/spec/unit/page_spec.rb

@@ -14,10 +14,9 @@ RSpec.describe TTY::Pager, '.page' do
     expect(TTY::Pager::NullPager).to have_received(:new)
   end
 
-  it "selects basic pager on non tty systems" do
+  it "selects BasicPager when no paging command is available" do
     basic_pager = spy(:basic_pager)
-    allow(described_class).to receive(:jruby?) { false }
-    allow(TTY::Pager::SystemPager).to receive(:can?) { false }
+    allow(TTY::Pager::SystemPager).to receive(:available?) { false }
     allow(TTY::Pager::BasicPager).to receive(:new) { basic_pager }
 
     pager = described_class.new
@@ -27,10 +26,9 @@ RSpec.describe TTY::Pager, '.page' do
     expect(basic_pager).to have_received(:page).with(text)
   end
 
-  it "selects system pager on systems with tty" do
+  it "selects SystemPager when paging command is available" do
     system_pager = spy(:system_pager)
-    allow(described_class).to receive(:jruby?) { false }
-    allow(TTY::Pager::SystemPager).to receive(:can?) { true }
+    allow(TTY::Pager::SystemPager).to receive(:available?) { true }
     allow(TTY::Pager::SystemPager).to receive(:new) { system_pager }
 
     pager = described_class.new

data/spec/unit/system/new_spec.rb

@@ -2,9 +2,9 @@
 
 RSpec.describe TTY::Pager::SystemPager, '#new' do
   it "raises error if system paging is not supported" do
-    allow(TTY::Pager::SystemPager).to receive(:can?).and_return(false)
+    allow(TTY::Pager::SystemPager).to receive(:available?).and_return(false)
     expect {
       TTY::Pager::SystemPager.new
-    }.to raise_error(TTY::Pager::Error, "TTY::Pager::SystemPager cannot be used on your system. Try using BasicPager instead.")
+    }.to raise_error(TTY::Pager::Error, "TTY::Pager::SystemPager cannot be used on your system due to lack of appropriate pager executable. Install `less` like pager or try using `BasicPager` instead.")
   end
 end

data/spec/unit/system/page_spec.rb

@@ -1,39 +1,21 @@
 # coding: utf-8
 
 RSpec.describe TTY::Pager::SystemPager, '.page' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-
   it "executes the pager command in a subprocess" do
     text     = "I try all things, I achieve what I can.\n"
-    allow(TTY::Pager::SystemPager).to receive(:can?).and_return(true)
-    pager    = described_class.new(output: output, input: input)
-    read_io  = spy
+    allow(TTY::Pager::SystemPager).to receive(:available?).and_return(true)
+    output   = double(:output, :tty? => true)
+    pager    = described_class.new(output: output)
     write_io = spy
+    pid      = 12345
 
-    if !pager.respond_to?(:fork)
-      described_class.send :define_method, :fork, lambda { |*args|
-        yield if block_given?
-      }
-    end
-
-    allow(IO).to receive(:pipe).and_return([read_io, write_io])
-
-    allow(pager).to receive(:fork) do |&block|
-      allow(input).to receive(:reopen)
-      allow(IO).to receive(:select)
-      allow(pager).to receive(:pager_command).and_return('less')
-      allow(pager).to receive(:exec)
-      block.call
-    end.and_return(12345)
-
+    allow(pager).to receive(:open).and_return(write_io)
+    allow(write_io).to receive(:pid).and_return(pid)
     status = double(:status, :success? => true)
-    allow(Process).to receive(:waitpid2).with(12345).and_return([1, status])
+    allow(Process).to receive(:waitpid2).with(pid, any_args).and_return([1, status])
 
     expect(pager.page(text)).to eq(true)
-
-    expect(IO).to have_received(:select).with([input])
-    expect(pager).to have_received(:exec).with('less')
-    expect(output.read).to eq('')
+    expect(write_io).to have_received(:write).with(text)
+    expect(write_io).to have_received(:close)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-pager
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen