tty-pager 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 708a7b7003e1bba7b41ded5cfec547b1291bebcb
-  data.tar.gz: deac81e148568067aff03907e587942c8592d4cf
+  metadata.gz: f49536d3b9e164578f6d5ad3b561eacc9c2d6115
+  data.tar.gz: d5db6acf71e24ae57853b0623f49c18f0b05aedc
 SHA512:
-  metadata.gz: 94c0e42d639c96705d4d33809fb9c5071e0747aa6c2cf8f29c5782f2d25d184fb4939038d0b2dfa13a234818ac0c01b263c2034f6820e51571fdd441e6fe8783
-  data.tar.gz: 156fd7831660b6ff9963e044d28c7c93df7f91cd65d5a6f27c0bb5ce34f7c63f50df712fc9d96b883c5e68fdce20c49736192aee516ed103cf4393c43e3f91ac
+  metadata.gz: f5c1a7349501d0ab69a3b626356e9c81af6af26c52e44d0fae16f0612e203ac649dec918b99e06dff930ec145acdd90db54a55d228f6648c2961053551d70c29
+  data.tar.gz: d6b107adf86a78772c73012e1f28c61c482a470d9fd90a46706bb92e8ca3cece43a90d19c8d86fadec66ebedc8d803ec0ee5d57615f20e607e3b35548c542074

data/.travis.yml

@@ -10,7 +10,7 @@ rvm:
   - 2.1.10
   - 2.2.6
   - 2.3.3
-  - 2.4.0
+  - 2.4.1
   - ruby-head
   - jruby-9000
   - jruby-head

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [v0.8.0] - 2017-07-14
+
+### Added
+* Add :command option to SystemPager to enforce choice of pagination tool
+* Add Error type for specific error notifications
+
+### Changed
+* Change SystemPager to prevent initialization if pager isn't supported
+
+### Fixed
+* Fix BasicPager to take terminal width into account when displaying page break messages
+* Fix SystemPager on Windows by detecting fork implementation
+
 ## [v0.7.1] - 2017-04-09
 
 ### Fixed

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at [email]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -32,10 +32,15 @@ Or install it yourself as:
 
     $ gem install tty-pager
 
-## 1. Usage
+
+## 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.
 
+## 1. Usage
+
+In order to let **TTY::Pager** pick the best paging mechanism automatically do:
+
 ```ruby
 pager = TTY::Pager.new
 ```
@@ -52,19 +57,44 @@ If you want to use specific pager you can do so by invoking it directly
 pager = TTY::Pager::BasicPager.new
 ```
 
-If you want to disable the pager pass the `:enabled` option:
+## 2. Interface
+
+### :enabled
+
+If you want to disable the pager pass the `:enabled` option set to `false`:
 
 ```ruby
 pager = TTY::Pager.new enabled: false
 ```
 
-For the `BasicPager` you can also pass a `:prompt` option to change the page break text:
+### :width
+
+The `BasicPager` allows to wrap content at given width:
+
+```ruby
+pager = TTY::Pager::BasicPager.new width: 80
+```
+
+### :prompt
+
+For the `BasicPager` you can 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
 ```
 
+### :command
+
+You can force `SystemPager` to always use a specific paging tool by passing the `:command` option:
+
+```ruby
+TTY::Pager.new command; 'less -R'
+TTY::Pager::SystemPager.new command: 'less -R'
+```
+
+### PAGER
+
 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
@@ -80,6 +110,8 @@ ENV['PAGER']='less'
 
 ## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-pager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
 1. Fork it ( https://github.com/piotrmurach/tty-pager/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/examples/basic_pager.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'tty-pager'
+
+pager = TTY::Pager::BasicPager.new(width: 80)
+file = File.join(File.dirname(__FILE__), 'temp.txt')
+pager.page(File.read(file))

data/lib/tty/pager/basic.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # coding: utf-8
 
 require 'verse'
@@ -9,6 +10,36 @@ module TTY
     #
     # @api public
     class BasicPager < Pager
+      PAGE_BREAK = "\n--- Page -%s- " \
+                    "Press enter/return to continue " \
+                    "(or q to quit) ---".freeze
+
+      # Create a basic pager
+      #
+      # @option options [Integer] :height
+      #   the terminal height
+      # @option options [Integer] :width
+      #   the terminal width
+      #
+      # @api public
+      def initialize(options = {})
+        super
+        @height  = options.fetch(:height) { page_height }
+        @width   = options.fetch(:width)  { page_width }
+        @prompt  = options.fetch(:prompt) { default_prompt }
+        prompt_height = PAGE_BREAK.lines.to_a.size
+        @height -= prompt_height
+      end
+
+      # Default prompt for paging
+      #
+      # @return [Proc]
+      #
+      # @api private
+      def default_prompt
+        proc { |page_num| output.puts Verse.wrap(PAGE_BREAK % page_num, @width) }
+      end
+
       # Page text
       #
       # @api public

data/lib/tty/pager/system.rb

@@ -9,6 +9,22 @@ module TTY
     #
     # @api public
     class SystemPager < Pager
+      # Create a system pager
+      #
+      # @param [Hash] options
+      # @option options [String] :command
+      #   the command to use for paging
+      #
+      # @api public
+      def initialize(options = {})
+        super
+        @pager_command = options[:command]
+        unless self.class.can?
+          raise TTY::Pager::Error, "#{self.class.name} cannot be used on your" \
+                                   " system. Try using BasicPager instead."
+        end
+      end
+
       # Find first available system command for paging
       #
       # @example Basic usage
@@ -24,9 +40,9 @@ module TTY
       # @api public
       def self.available(*commands)
         commands = commands.empty? ? executables : commands
-        commands.
-          compact.map(&:strip).reject(&:empty?).uniq.
-          find { |cmd| command_exists?(cmd.split.first) }
+        commands
+          .compact.map(&:strip).reject(&:empty?).uniq
+          .find { |cmd| command_exists?(cmd.split.first) }
       end
 
       # Check if command is available
@@ -44,6 +60,28 @@ 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

data/lib/tty/pager/version.rb

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

data/lib/tty/pager.rb

@@ -9,11 +9,7 @@ require_relative "pager/version"
 
 module TTY
   class Pager
-    PROMPT_HEIGHT = 2
-
-    PAGE_BREAK = "\n--- Page -%s- " \
-                  "Press enter/return to continue " \
-                  "(or q to quit) ---".freeze
+    Error = Class.new(StandardError)
 
     # Create a pager
     #
@@ -24,38 +20,20 @@ module TTY
     #   the object to send input to
     # @option options [IO] :output
     #   the object to send output to
-    # @option options [Integer] :height
-    #   the terminal height
-    # @option options [Integer] :width
-    #   the terminal width
     # @option options [Boolean] :enabled
     #   disable/enable text paging
     #
     # @api public
     def initialize(options = {})
-      @height  = options.fetch(:height) { page_height }
-      @width   = options.fetch(:width)  { page_width }
       @input   = options.fetch(:input)  { $stdin }
       @output  = options.fetch(:output) { $stdout }
       @enabled = options.fetch(:enabled) { true }
-      @prompt  = options.fetch(:prompt) { default_prompt }
-      @height -= PROMPT_HEIGHT
-      @output = output
 
       if self.class == TTY::Pager
-        @pager = find_available
+        @pager = find_available(options)
       end
     end
 
-    # Default prompt for paging
-    #
-    # @return [Proc]
-    #
-    # @api private
-    def default_prompt
-      proc { |page_num| output.puts PAGE_BREAK % page_num }
-    end
-
     # Check if pager is enabled
     #
     # @return [Boolean]
@@ -111,13 +89,13 @@ module TTY
     # is pure Ruby implementation.
     #
     # @api private
-    def find_available
+    def find_available(options)
       if !enabled?
         NullPager.new
-      elsif SystemPager.available? && !Pager.jruby?
-        SystemPager.new
+      elsif !Pager.jruby? && SystemPager.can?
+        SystemPager.new(options)
       else
-        BasicPager.new
+        BasicPager.new(options)
       end
     end
 

data/spec/unit/basic/page_spec.rb

@@ -31,7 +31,14 @@ RSpec.describe TTY::Pager::BasicPager, '.page' do
       "any map; ",
       "true ",
       "",
-      "--- Page -1- Press enter/return to continue (or q to quit) ---",
+      "--- Page ",
+      "-1- Press ",
+      "e",
+      "nter/retur",
+      "n to ",
+      "continue ",
+      "(or q to ",
+      "quit) ---",
       "places ",
       "never are.\n"
     ].join("\n"))
@@ -111,7 +118,7 @@ RSpec.describe TTY::Pager::BasicPager, '.page' do
     input << "\n\n\n"
     input.rewind
     pager = described_class.new(output: output, input: input,
-                                width: 1, height: 5)
+                                width: 80, height: 5)
     pager.page(text)
     expect(output.string).to eq([
       "a",

data/spec/unit/page_spec.rb

@@ -16,7 +16,8 @@ RSpec.describe TTY::Pager, '.page' do
 
   it "selects basic pager on non tty systems" do
     basic_pager = spy(:basic_pager)
-    allow(TTY::Pager::SystemPager).to receive(:available?) { false }
+    allow(described_class).to receive(:jruby?) { false }
+    allow(TTY::Pager::SystemPager).to receive(:can?) { false }
     allow(TTY::Pager::BasicPager).to receive(:new) { basic_pager }
 
     pager = described_class.new
@@ -28,8 +29,8 @@ RSpec.describe TTY::Pager, '.page' do
 
   it "selects system pager on systems with tty" do
     system_pager = spy(:system_pager)
-    allow(TTY::Pager::SystemPager).to receive(:available?) { true }
     allow(described_class).to receive(:jruby?) { false }
+    allow(TTY::Pager::SystemPager).to receive(:can?) { true }
     allow(TTY::Pager::SystemPager).to receive(:new) { system_pager }
 
     pager = described_class.new

data/spec/unit/system/available_spec.rb

@@ -33,7 +33,8 @@ RSpec.describe TTY::Pager::SystemPager, '#available' do
 
     it "does not error" do
       allow(pager).to receive(:executables).and_return(execs)
-      expect(pager.available).to eql("less")
+      allow(pager).to receive(:command_exists?).with('less') { true }
+      expect(pager.available).to eql('less')
     end
   end
 

data/spec/unit/system/new_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+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)
+    expect {
+      TTY::Pager::SystemPager.new
+    }.to raise_error(TTY::Pager::Error, "TTY::Pager::SystemPager cannot be used on your system. Try using BasicPager instead.")
+  end
+end

data/spec/unit/system/page_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe TTY::Pager::SystemPager, '.page' do
 
   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
     write_io = spy

data/tty-pager.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'rspec', '~> 3.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-pager
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
 description: Terminal output paging in a cross-platform way supporting all major ruby
   interpreters.
 email:
@@ -112,11 +112,13 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - appveyor.yml
+- examples/basic_pager.rb
 - examples/system_pager.rb
 - examples/temp.txt
 - lib/tty-pager.rb
@@ -131,6 +133,7 @@ files:
 - spec/unit/page_spec.rb
 - spec/unit/system/available_spec.rb
 - spec/unit/system/command_exists_spec.rb
+- spec/unit/system/new_spec.rb
 - spec/unit/system/page_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
@@ -168,5 +171,6 @@ test_files:
 - spec/unit/page_spec.rb
 - spec/unit/system/available_spec.rb
 - spec/unit/system/command_exists_spec.rb
+- spec/unit/system/new_spec.rb
 - spec/unit/system/page_spec.rb
 has_rdoc: