tty-pager 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 762884b7e1c8aed7cb329a22577247b1d13e3dec
-  data.tar.gz: 3a0e5d127f2348ab58a7e95402b4a76c8cf1aea9
+  metadata.gz: 90d482658df231505821c563a80f8e47c1e57d9b
+  data.tar.gz: 6b2bf29fc1e0b6d3dfc60f2ff9819507dc35c62c
 SHA512:
-  metadata.gz: 9fbcf3ac3cbbbe53591bc2ced88aa28af51825e6d094f2fe22d7aa47940293f8b0fb8abca0861d98664de6b3bb7397b12477973a5599fd36aade65b8918e7d2e
-  data.tar.gz: a7632fc1596b11cd0e9a4aa9d2bde295020b856eca9e5e2f6b28aca8252d4db5228a4a7e177920851d68e8db5b1aae6f47800c3ff25af8f9ca3a3b5cc3b27594
+  metadata.gz: 891ef637078cc33f4a3821a4ed847d8703a353803bfb2183016a818cf09bb0bd9a42e813a206660654973d8adaf43ec9b9e86476938d47f9b75addd6f1f8052d
+  data.tar.gz: 4239ae39b7dbfe716db15869fc0768cc6f5c941d7161eba78f14991cae2b20671567c9282e73a0431a60df666bcbc6adddce2cbdeda57fef3a29ed79c3c5b790

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.2.0 (June 27, 2015)
+
+* Change SystemPager to correctly paginate inside a process.

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :development do
   gem 'rake',    '~> 10.4.2'
-  gem 'rspec',   '~> 3.2.0'
+  gem 'rspec',   '~> 3.3.0'
   gem 'yard',    '~> 0.8.7'
 end
 

data/README.md

@@ -31,13 +31,13 @@ Or install it yourself as:
 
 ## 1. Usage
 
-The **TTY::Pager** upon initialization will choose the best available pager out of `SystemPager`, `BasicPager` or `NullPager`. If paging is disabled then a `NullPager` is used that simply prints content out to stdout, otherwise a check is performed to find native system executable to perform pagination natively with `SystemPager`. 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 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.
 
 ```ruby
 pager = TTY::Pager.new
 ```
 
-Then to perform actual content pagination invoke `page` like so:
+Then to perform actual content pagination invoke `page` method with the content to paginate as the argument:
 
 ```ruby
 pager.page("Very long text...")
@@ -55,13 +55,26 @@ If you want to disable the pager pass the `:enabled` option:
 pager = TTY::Pager.new enabled: false
 ```
 
-For the `BasicPager` you can also pass a `:prompt` option to change the page break content:
+For the `BasicPager` you can also pass a `:prompt` option to change the page break text:
 
 ```ruby
 prompt = -> (page_num) { output.puts "Page -#{page_num}- Press enter to continue" }
 pager = TTY::Pager::BasicPager.new prompt: prompt
 ```
 
+By default the `SystemPager` will check the `PAGER` environment variable, if not set it will try one of the `less`, `more`, `cat`, `pager`. Therefore, if you wish to set your prefered pager you can either set up your shell like so:
+
+```bash
+PAGER=less
+export PAGER
+```
+
+or set `PAGER` in Ruby script:
+
+```ruby
+ENV['PAGER']='less'
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/peter-murach/tty-pager/fork )

data/lib/tty/pager/system.rb

@@ -43,19 +43,19 @@ module TTY
       # Use system command to page output text
       #
       # @example
-      #  page('some long text...')
+      #   page('some long text...')
       #
       # @param [String] text
       #   the text to paginate
       #
-      # @return [nil]
+      # @return [Boolean]
+      #   the success status of launching a process
       #
       # @api public
       def page(text, &callback)
         read_io, write_io = IO.pipe
 
-        if Kernel.fork
-          # parent process
+        pid = Kernel.fork do
           write_io.close
           input.reopen(read_io)
           read_io.close
@@ -68,12 +68,14 @@ module TTY
           rescue SystemCallError
             exit 1
           end
-        else
-          # child process
-          read_io.close
-          write_io.write(text)
-          write_io.close
         end
+
+        read_io.close
+        write_io.write(text)
+        write_io.close
+
+        _, status = Process.waitpid2(pid)
+        status.success?
       end
 
       private
@@ -86,7 +88,7 @@ module TTY
       def self.executables
         [ENV['GIT_PAGER'], ENV['PAGER'],
          `git config --get-all core.pager`.split.first,
-        'less', 'more', 'cat', 'pager']
+         'less', 'more', 'cat', 'pager']
       end
       private_class_method :executables
 
@@ -104,7 +106,6 @@ module TTY
       def self.command_exists?(command)
         !TTY::Which.which(command).nil?
       end
-      private_class_method :command_exists?
 
       # The pager command to run
       #
@@ -114,10 +115,10 @@ module TTY
       # @api private
       def pager_command(*commands)
         @pager_command = if @pager_command && commands.empty?
-          @pager_command
-        else
-          self.class.available(*commands)
-        end
+                           @pager_command
+                         else
+                           self.class.available(*commands)
+                         end
       end
     end # SystemPager
   end # Pager

data/lib/tty/pager/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Pager
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end # Pager
 end # TTY

data/spec/unit/system/available_spec.rb

@@ -22,4 +22,9 @@ RSpec.describe TTY::Pager::SystemPager, '#available' do
     allow(pager).to receive(:command_exists?).with('more') { true }
     expect(pager.available('more')).to eql('more')
   end
+
+  it "allows to query for available command" do
+    allow(pager).to receive(:available).with('less') { true }
+    expect(pager.available?('less')).to eq(true)
+  end
 end

data/spec/unit/system/command_exists_spec.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+RSpec.describe TTY::Pager::SystemPager, '#command_exists?' do
+  subject(:pager) { described_class }
+
+  it "successfully checks command exists on the system" do
+    allow(TTY::Which).to receive(:which).with('less').and_return('/usr/bin/less')
+    expect(pager.command_exists?('less')).to eq(true)
+  end
+
+  it "fails to check command exists on the system" do
+    allow(TTY::Which).to receive(:which).with('less').and_return(nil)
+    expect(pager.command_exists?('less')).to eq(false)
+  end
+end

data/spec/unit/system/page_spec.rb

@@ -1,20 +1,29 @@
 # coding: utf-8
 
 RSpec.describe TTY::Pager::SystemPager, '.page' do
-  let(:input)    { StringIO.new }
-  let(:output)   { StringIO.new }
+  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"
-    pager = described_class.new(output: output, input: input)
+    text     = "I try all things, I achieve what I can.\n"
+    pager    = described_class.new(output: output, input: input)
+    read_io  = spy
+    write_io = spy
 
-    allow(pager).to receive(:exec)
-    allow(Kernel).to receive(:fork).and_return(true)
-    allow(pager).to receive(:pager_command).and_return('less')
-    allow(IO).to receive(:select)
-    allow(input).to receive(:reopen)
+    allow(IO).to receive(:pipe).and_return([read_io, write_io])
 
-    pager.page(text)
+    allow(Kernel).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)
+
+    status = double(:status, :success? => true)
+    allow(Process).to receive(:waitpid2).with(12345).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')

data/tasks/console.rake

@@ -8,3 +8,4 @@ task :console do
   ARGV.clear
   IRB.start
 end
+task :c => :console

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-pager
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2015-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -78,6 +78,7 @@ files:
 - .rspec
 - .ruby-version
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -93,6 +94,7 @@ files:
 - spec/unit/null/page_spec.rb
 - spec/unit/page_spec.rb
 - spec/unit/system/available_spec.rb
+- spec/unit/system/command_exists_spec.rb
 - spec/unit/system/page_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
@@ -129,5 +131,6 @@ test_files:
 - spec/unit/null/page_spec.rb
 - spec/unit/page_spec.rb
 - spec/unit/system/available_spec.rb
+- spec/unit/system/command_exists_spec.rb
 - spec/unit/system/page_spec.rb
 has_rdoc: