tty-pager 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5068805a1211cec15c39034ed548d2fbfcad5cbd
-  data.tar.gz: cd86b711c7bfed1c40847e0e501555229fd3a4f5
+  metadata.gz: 55f5c44928591973014fd8a38e846c47450825a7
+  data.tar.gz: 6d569bedaa777b130deb2ce2a6ffea24580f6113
 SHA512:
-  metadata.gz: 3844899a4cb559a69bc3b34fc50e624ace2538d6b4c5ce75a346b0b775d77060d5ab881714df960ae3efd06a7066316cd68f0f4e8849ec54bf96c6079fac348f
-  data.tar.gz: f17e9f459947dd9cd937d0612afcb67e3cc6354b81d2c1015177404b4cd4dd2f31a8d851f109b58b0187a50177095fff350306139356f4c9292c7184da435ed4
+  metadata.gz: adb81f00fba4a7ffbf9f76e638fccf4699305a1e932003fd20a89f4a737d0a8da1f95945dd66e20fd55d75742fd2171ed15a34935e4393513f8f2c1b4badfeb9
+  data.tar.gz: cdd003dbeeab701b181693b6e53cac19c75c1a338896c5bce11a4ead8d233ec358f8834041651babe9230ca6dfefc806e725cd11d7c04a7e75ce6976e3629f18

data/.travis.yml

@@ -7,9 +7,9 @@ script: "bundle exec rake ci"
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.1
+  - 2.2.8
+  - 2.3.6
+  - 2.4.3
   - ruby-head
   - jruby-9.1.5.0
   - jruby-head

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change log
 
+## [v0.11.0] - 2018-01-11
+
+### Added
+* Add `pg` and `most` to executables lookup
+
+### Changed
+* Change verse to strings dependency
+* Change SystemPager to make all class methods public
+* Change SystemPager#available to #find_executable
+* Change SystemPager#available? to #exec_available
+* Change Pager#find_available to #select_pager and make class method
+
+### Fixed
+* Fix Pager throwing exception if git is not installed by Katelyn Schiesser(@slowbro)
+
 ## [v0.10.0] - 2017-10-29
 
 ### Changed
@@ -69,6 +84,7 @@
 ### Changed
 * Change SystemPager to correctly paginate inside a process.
 
+[v0.11.0]: https://github.com/peter-murach/tty-prompt/compare/v0.10.0...v0.11.0
 [v0.10.0]: https://github.com/peter-murach/tty-prompt/compare/v0.9.0...v0.10.0
 [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

data/Gemfile

@@ -3,12 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'yard',    '~> 0.8.7'
+  gem 'yard', '~> 0.9.12'
 end
 
 group :metrics do
-  gem 'coveralls', '~> 0.8.1'
-  gem 'simplecov', '~> 0.10.0'
+  gem 'coveralls', '~> 0.8.21'
+  gem 'simplecov', '~> 0.14.1'
   gem 'yardstick', '~> 0.9.9'
-  gem 'term-ansicolor', '=1.3.2'
 end

data/README.md

@@ -1,8 +1,9 @@
 # TTY::Pager [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
 [![Gem Version](https://badge.fury.io/rb/tty-pager.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/tty-pager.svg?branch=master)][travis]
 [![Build status](https://ci.appveyor.com/api/projects/status/3auc1vi3mk5puqai?svg=true)][appveyor]
-[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-pager/badges/gpa.svg)][codeclimate]
+[![Maintainability](https://api.codeclimate.com/v1/badges/636da0d02231b7f3e50f/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-pager/badge.svg)][coverage]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/tty-pager.svg?branch=master)][inchpages]
 
@@ -10,7 +11,7 @@
 [gem]: http://badge.fury.io/rb/tty-pager
 [travis]: http://travis-ci.org/piotrmurach/tty-pager
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-pager
-[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-pager
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-pager/maintainability
 [coverage]: https://coveralls.io/github/piotrmurach/tty-pager
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty-pager
 
@@ -120,4 +121,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/piotrm
 
 ## Copyright
 
-Copyright (c) 2015-2017 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2015-2018 Piotr Murach. See LICENSE for further details.

data/examples/basic_pager.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'tty-pager'
+require_relative '../lib/tty-pager'
 
 pager = TTY::Pager::BasicPager.new(width: 80)
 file = File.join(File.dirname(__FILE__), 'temp.txt')

data/examples/pager.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/tty-pager'
+
+ENV['PAGER']='less'
+
+pager = TTY::Pager.new
+file = File.join(File.dirname(__FILE__), 'temp.txt')
+pager.page(File.read(file))

data/examples/system_pager.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'tty-pager'
+require_relative '../lib/tty-pager'
 
 ENV['PAGER']='less'
 

data/lib/tty/pager.rb

@@ -9,6 +9,25 @@ module TTY
   class Pager
     Error = Class.new(StandardError)
 
+    # Select an appriopriate pager
+    #
+    # If the user disabled paging then a NullPager is returned,
+    # otherwise a check is performed to find native system
+    # 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 self.select_pager(enabled)
+      if !enabled
+        NullPager
+      elsif SystemPager.exec_available?
+        SystemPager
+      else
+        BasicPager
+      end
+    end
+
     # Create a pager
     #
     # @param [Hash] options
@@ -28,7 +47,7 @@ module TTY
       @enabled = options.fetch(:enabled) { true }
 
       if self.class == TTY::Pager
-        @pager = find_available(options)
+        @pager = self.class.select_pager(@enabled).new(options)
       end
     end
 
@@ -78,23 +97,5 @@ module TTY
 
     attr_reader :pager
 
-    # Find available pager
-    #
-    # If the user disabled paging then a NullPager is returned,
-    # otherwise a check is performed to find native system
-    # 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 SystemPager.available?
-        SystemPager.new(options)
-      else
-        BasicPager.new(options)
-      end
-    end
   end # Pager
 end # TTY

data/lib/tty/pager/basic.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'verse'
+require 'strings'
 
 module TTY
   class Pager
@@ -36,7 +36,7 @@ module TTY
       #
       # @api private
       def default_prompt
-        proc { |page_num| output.puts Verse.wrap(PAGE_BREAK % page_num, @width) }
+        proc { |page_num| output.puts Strings.wrap(PAGE_BREAK % page_num, @width) }
       end
 
       # Page text
@@ -53,7 +53,7 @@ module TTY
             chunk = leftover
             leftover = []
           end
-          wrapped_line = Verse.wrap(line, @width)
+          wrapped_line = Strings.wrap(line, @width)
           wrapped_line.lines.each do |line_part|
             if lines_left > 0
               chunk << line_part

data/lib/tty/pager/system.rb

@@ -9,40 +9,49 @@ module TTY
     #
     # @api public
     class SystemPager < Pager
-      # Create a system pager
+      # Check if command exists
       #
-      # @param [Hash] options
-      # @option options [String] :command
-      #   the command to use for paging
+      # @example
+      #   command_exists?('less) # => true
       #
-      # @api public
-      def initialize(options = {})
-        super
-        @pager_command = options[:command]
-        unless self.class.available?
-          raise TTY::Pager::Error, "#{self.class.name} cannot be used on your" \
-                                   " system due to lack of appropriate pager" \
-                                   " executable. Install `less` like pager or" \
-                                   " try using `BasicPager` instead." \
-        end
+      # @param [String] command
+      #   the command to check
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def self.command_exists?(command)
+        TTY::Which.exist?(command)
       end
 
-      # Find first available system command for paging
+      # List possible executables for output paging
+      #
+      # @return [Array[String]]
+      #
+      # @api private
+      def self.executables
+        [ENV['GIT_PAGER'], ENV['PAGER'],
+         command_exists?('git') ? `git config --get-all core.pager` : nil,
+         'less', 'more', 'cat', 'pager', 'pg', 'most'].compact
+      end
+
+      # Find first available termainal pager program executable
       #
       # @example Basic usage
-      #   available # => 'less'
+      #   find_executable # => 'less'
       #
       # @example Usage with commands
-      #   available('less', 'cat')  # => 'less'
+      #   find_executable('less', 'cat')  # => 'less'
       #
       # @param [Array[String]] commands
       #
-      # @return [String]
+      # @return [String, nil]
+      #   the found executable or nil when not found
       #
       # @api public
-      def self.available(*commands)
-        commands = commands.empty? ? executables : commands
-        commands
+      def self.find_executable(*commands)
+        execs = commands.empty? ? executables : commands
+        execs
           .compact.map(&:strip).reject(&:empty?).uniq
           .find { |cmd| command_exists?(cmd.split.first) }
       end
@@ -58,8 +67,26 @@ module TTY
       # @return [Boolean]
       #
       # @api public
-      def self.available?(*commands)
-        !available(*commands).nil?
+      def self.exec_available?(*commands)
+        !find_executable(*commands).nil?
+      end
+
+      # 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.exec_available?
+          raise TTY::Pager::Error, "#{self.class.name} cannot be used on your" \
+                                   " system due to lack of appropriate pager" \
+                                   " executable. Install `less` like pager or" \
+                                   " try using `BasicPager` instead." \
+        end
       end
 
       # Use system command to page output text
@@ -90,35 +117,6 @@ module TTY
         true
       end
 
-      private
-
-      # List possible executables for output paging
-      #
-      # @return [Array[String]]
-      #
-      # @api private
-      def self.executables
-        [ENV['GIT_PAGER'], ENV['PAGER'],
-         `git config --get-all core.pager`,
-         'less', 'more', 'cat', 'pager']
-      end
-      private_class_method :executables
-
-      # Check if command exists
-      #
-      # @example
-      #   command_exists?('less) # => true
-      #
-      # @param [String] command
-      #   the command to check
-      #
-      # @return [Boolean]
-      #
-      # @api private
-      def self.command_exists?(command)
-        TTY::Which.exist?(command)
-      end
-
       # The pager command to run
       #
       # @return [String]
@@ -129,7 +127,7 @@ module TTY
         @pager_command = if @pager_command && commands.empty?
                            @pager_command
                          else
-                           self.class.available(*commands)
+                           self.class.find_executable(*commands)
                          end
       end
     end # SystemPager

data/lib/tty/pager/version.rb

@@ -1,5 +1,5 @@
 module TTY
   class Pager
-    VERSION = "0.10.0"
+    VERSION = '0.11.0'.freeze
   end # Pager
 end # TTY

data/spec/unit/basic/page_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe TTY::Pager::BasicPager, '.page' do
   let(:input)  { StringIO.new }
   let(:output) { StringIO.new }
@@ -16,8 +18,7 @@ RSpec.describe TTY::Pager::BasicPager, '.page' do
   end
 
   it "breaks text exceeding terminal width" do
-    text = ""
-    text << "It is not down on any map; true places never are.\n"
+    text = "It is not down on any map; true places never are.\n"
     input << "\n"
     input.rewind
     pager = described_class.new(output: output, input: input,
@@ -43,13 +44,13 @@ RSpec.describe TTY::Pager::BasicPager, '.page' do
   end
 
   it "continues paging when enter is pressed" do
-    text = ""
+    text = []
     10.times { text << "I try all things, I achieve what I can.\n"}
     input << "\n\n\n"
     input.rewind
     pager = described_class.new(output: output, input: input,
                                 width: 100, height: 5)
-    pager.page(text)
+    pager.page(text.join)
     expect(output.string).to eq([
       "I try all things, I achieve what I can.",
       "I try all things, I achieve what I can.",
@@ -71,13 +72,13 @@ RSpec.describe TTY::Pager::BasicPager, '.page' do
   end
 
   it "stops paging when q is pressed" do
-    text = ""
+    text = []
     10.times { text << "I try all things, I achieve what I can.\n"}
     input << "\nq\n"
     input.rewind
     pager = described_class.new(output: output, input: input,
                                 width: 100, height: 5)
-    pager.page(text)
+    pager.page(text.join)
     expect(output.string).to eq([
       "I try all things, I achieve what I can.",
       "I try all things, I achieve what I can.",
@@ -93,14 +94,14 @@ RSpec.describe TTY::Pager::BasicPager, '.page' do
   end
 
   it "allows to change paging prompt" do
-    text = ""
+    text = []
     5.times { text << "I try all things, I achieve what I can.\n"}
     input << "\nq\n"
     input.rewind
     prompt = proc { |num| output.puts "Page -#{num}-" }
     pager = described_class.new(output: output, input: input,
                                 width: 100, height: 5, prompt: prompt)
-    pager.page(text)
+    pager.page(text.join)
     expect(output.string).to eq([
       "I try all things, I achieve what I can.",
       "I try all things, I achieve what I can.",

data/spec/unit/page_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe TTY::Pager, '.page' do
 
   it "selects BasicPager when no paging command is available" do
     basic_pager = spy(:basic_pager)
-    allow(TTY::Pager::SystemPager).to receive(:available?) { false }
+    allow(TTY::Pager::SystemPager).to receive(:exec_available?) { false }
     allow(TTY::Pager::BasicPager).to receive(:new) { basic_pager }
 
     pager = described_class.new
@@ -26,7 +26,7 @@ RSpec.describe TTY::Pager, '.page' do
 
   it "selects SystemPager when paging command is available" do
     system_pager = spy(:system_pager)
-    allow(TTY::Pager::SystemPager).to receive(:available?) { true }
+    allow(TTY::Pager::SystemPager).to receive(:exec_available?) { true }
     allow(TTY::Pager::SystemPager).to receive(:new) { system_pager }
 
     pager = described_class.new

data/spec/unit/system/executables_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Pager::SystemPager do
+  it "provides executable names" do
+    allow(ENV).to receive(:[]).with('GIT_PAGER').and_return(nil)
+    allow(ENV).to receive(:[]).with('PAGER').and_return(nil)
+    allow(described_class).to receive(:command_exists?).with('git').and_return(false)
+
+    expect(described_class.executables).to eq(['less', 'more', 'cat', 'pager', 'pg', 'most'])
+  end
+end

data/spec/unit/system/{available_spec.rb → find_executable_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe TTY::Pager::SystemPager, '#available' do
+RSpec.describe TTY::Pager::SystemPager, '#find_executable' do
   let(:execs)   { ['less', 'more'] }
 
   subject(:pager) { described_class }
@@ -7,23 +7,23 @@ RSpec.describe TTY::Pager::SystemPager, '#available' do
     allow(pager).to receive(:executables).and_return(execs)
     allow(pager).to receive(:command_exists?).with('less') { true }
     allow(pager).to receive(:command_exists?).with('more') { false }
-    expect(pager.available).to eql('less')
+    expect(pager.find_executable).to eql('less')
   end
 
   it "doesn't find command" do
     allow(pager).to receive(:executables).and_return(execs)
     allow(pager).to receive(:command_exists?) { false }
-    expect(pager.available).to be_nil
+    expect(pager.find_executable).to be_nil
   end
 
   it "takes precedence over other commands" do
     allow(pager).to receive(:command_exists?).with('more') { true }
-    expect(pager.available('more')).to eql('more')
+    expect(pager.find_executable('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)
+    allow(pager).to receive(:find_executable).with('less') { true }
+    expect(pager.exec_available?('less')).to eq(true)
   end
 
   context "when given nil, blank, and whitespace commands" do
@@ -32,7 +32,7 @@ RSpec.describe TTY::Pager::SystemPager, '#available' do
     it "does not error" do
       allow(pager).to receive(:executables).and_return(execs)
       allow(pager).to receive(:command_exists?).with('less') { true }
-      expect(pager.available).to eql('less')
+      expect(pager.find_executable).to eql('less')
     end
   end
 
@@ -42,7 +42,7 @@ RSpec.describe TTY::Pager::SystemPager, '#available' do
     it "finds the command" do
       allow(pager).to receive(:executables).and_return(execs)
       allow(pager).to receive(:command_exists?).with("diff-so-fancy") { true }
-      expect(pager.available).to eql(execs.first)
+      expect(pager.find_executable).to eql(execs.first)
     end
   end
 end

data/spec/unit/system/new_spec.rb

@@ -1,6 +1,6 @@
 RSpec.describe TTY::Pager::SystemPager, '#new' do
   it "raises error if system paging is not supported" do
-    allow(TTY::Pager::SystemPager).to receive(:available?).and_return(false)
+    allow(TTY::Pager::SystemPager).to receive(:exec_available?).and_return(false)
     expect {
       TTY::Pager::SystemPager.new
     }.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.")

data/spec/unit/system/page_spec.rb

@@ -1,7 +1,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(:available?).and_return(true)
+    allow(TTY::Pager::SystemPager).to receive(:exec_available?).and_return(true)
     output   = double(:output, :tty? => true)
     pager    = described_class.new(output: output)
     write_io = spy

data/tty-pager.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'tty-screen', '~> 0.6.0'
+  spec.add_dependency 'tty-screen', '~> 0.6.4'
   spec.add_dependency 'tty-which',  '~> 0.3.0'
-  spec.add_dependency 'verse',      '~> 0.5.0'
+  spec.add_dependency 'strings',    '~> 0.1.0'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-pager
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-29 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: tty-which
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: verse
+  name: strings
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ files:
 - Rakefile
 - appveyor.yml
 - examples/basic_pager.rb
+- examples/pager.rb
 - examples/system_pager.rb
 - examples/temp.txt
 - lib/tty-pager.rb
@@ -131,8 +132,9 @@ files:
 - spec/unit/basic/page_spec.rb
 - 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/executables_spec.rb
+- spec/unit/system/find_executable_spec.rb
 - spec/unit/system/new_spec.rb
 - spec/unit/system/page_spec.rb
 - tasks/console.rake
@@ -169,8 +171,8 @@ test_files:
 - spec/unit/basic/page_spec.rb
 - 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/executables_spec.rb
+- spec/unit/system/find_executable_spec.rb
 - spec/unit/system/new_spec.rb
 - spec/unit/system/page_spec.rb
-has_rdoc: