tty-pager 0.12.1 → 0.13.0

data/Rakefile

@@ -1,8 +0,0 @@
-# coding: utf-8
-
-require 'bundler/gem_tasks'
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]

data/examples/basic_pager.rb

@@ -1,5 +0,0 @@
-require_relative '../lib/tty-pager'
-
-pager = TTY::Pager::BasicPager.new(width: 80)
-file = File.join(File.dirname(__FILE__), 'temp.txt')
-pager.page(File.read(file))

data/examples/markdown.rb

@@ -1,7 +0,0 @@
-require 'tty-markdown'
-require_relative '../lib/tty-pager'
-
-pager = TTY::Pager.new
-file = File.join(__dir__, '../README.md')
-text = TTY::Markdown.parse_file(file)
-pager.page(text)

data/examples/pager.rb

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

data/spec/spec_helper.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-if ENV['COVERAGE'] || ENV['TRAVIS']
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  SimpleCov.start do
-    command_name 'spec'
-    add_filter 'spec'
-  end
-end
-
-require 'tty-pager'
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  if config.files_to_run.one?
-    config.default_formatter = 'doc'
-  end
-
-  config.profile_examples = 2
-
-  config.order = :random
-
-  Kernel.srand config.seed
-end

data/spec/unit/basic/page_spec.rb

@@ -1,141 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Pager::BasicPager, '.page' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-
-  it "doesn't paginate empty string" do
-    pager = described_class.new(output: output, input: input)
-    pager.page("")
-    expect(output.string).to eq("")
-  end
-
-  it "doesn't paginate text that fits on screen" do
-    text = "I try all things, I achieve what I can.\n"
-    pager = described_class.new(output: output, width: 100, height: 10)
-    pager.page(text)
-    expect(output.string).to eq(text)
-  end
-
-  it "breaks text exceeding terminal width" do
-    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,
-                                width: 10, height: 6)
-    pager.page(text)
-    expect(output.string).to eq([
-      "It is not ",
-      "down on ",
-      "any map; ",
-      "true ",
-      "",
-      "--- Page ",
-      "-1- Press ",
-      "e",
-      "nter/retur",
-      "n to ",
-      "continue ",
-      "(or q to ",
-      "quit) ---",
-      "places ",
-      "never are.\n"
-    ].join("\n"))
-  end
-
-  it "continues paging when enter is pressed" do
-    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.join)
-    expect(output.string).to eq([
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "",
-      "--- Page -1- Press enter/return to continue (or q to quit) ---",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "",
-      "--- Page -2- Press enter/return to continue (or q to quit) ---",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "",
-      "--- Page -3- Press enter/return to continue (or q to quit) ---",
-      "I try all things, I achieve what I can.\n"
-    ].join("\n"))
-  end
-
-  it "stops paging when q is pressed" do
-    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.join)
-    expect(output.string).to eq([
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "",
-      "--- Page -1- Press enter/return to continue (or q to quit) ---",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "",
-      "--- Page -2- Press enter/return to continue (or q to quit) ---\n",
-    ].join("\n"))
-  end
-
-  it "allows to change paging prompt" do
-    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.join)
-    expect(output.string).to eq([
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.",
-      "Page -1-",
-      "I try all things, I achieve what I can.",
-      "I try all things, I achieve what I can.\n",
-    ].join("\n"))
-  end
-
-  it "preserves new lines when breaking" do
-    text = "a\na\na\na\na\na\na\na\na\na"
-    input << "\n\n\n"
-    input.rewind
-    pager = described_class.new(output: output, input: input,
-                                width: 80, height: 5)
-    pager.page(text)
-    expect(output.string).to eq([
-      "a",
-      "a",
-      "a",
-      "",
-      "--- Page -1- Press enter/return to continue (or q to quit) ---",
-      "a",
-      "a",
-      "a",
-      "",
-      "--- Page -2- Press enter/return to continue (or q to quit) ---",
-      "a",
-      "a",
-      "a",
-      "",
-      "--- Page -3- Press enter/return to continue (or q to quit) ---",
-      "a"
-    ].join("\n"))
-  end
-end

data/spec/unit/null/page_spec.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Pager::NullPager, '.page' do
-  let(:output)   { StringIO.new }
-
-  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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Pager, '.page' do
-  let(:output) { StringIO.new }
-
-  it "selects null pager when disabled" do
-    null_pager = spy(:null_pager)
-    allow(TTY::Pager::NullPager).to receive(:new) { null_pager }
-
-    pager = described_class.new(enabled: false)
-    text = "I try all things, I achieve what I can.\n"
-    pager.page(text)
-
-    expect(TTY::Pager::NullPager).to have_received(:new)
-  end
-
-  it "selects BasicPager when no paging command is available" do
-    basic_pager = spy(:basic_pager)
-    allow(TTY::Pager::SystemPager).to receive(:exec_available?) { false }
-    allow(TTY::Pager::BasicPager).to receive(:new) { basic_pager }
-
-    pager = described_class.new
-    text = "I try all things, I achieve what I can.\n"
-    pager.page(text)
-
-    expect(basic_pager).to have_received(:page).with(text)
-  end
-
-  it "selects SystemPager when paging command is available" do
-    system_pager = spy(:system_pager)
-    allow(TTY::Pager::SystemPager).to receive(:exec_available?) { true }
-    allow(TTY::Pager::SystemPager).to receive(:new) { system_pager }
-
-    pager = described_class.new
-    text = "I try all things, I achieve what I can.\n"
-    pager.page(text)
-
-    expect(system_pager).to have_received(:page).with(text)
-  end
-end

data/spec/unit/system/command_exists_spec.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-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(:exist?).with('less').and_return('/usr/bin/less').and_return(true)
-    expect(pager.command_exists?('less')).to eq(true)
-  end
-
-  it "fails to check command exists on the system" do
-    allow(TTY::Which).to receive(:exist?).with('less').and_return(false)
-    expect(pager.command_exists?('less')).to eq(false)
-  end
-end

data/spec/unit/system/executables_spec.rb

@@ -1,11 +0,0 @@
-# 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 -r', 'more -r', 'most', 'cat', 'pager', 'pg'])
-  end
-end

data/spec/unit/system/find_executable_spec.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Pager::SystemPager, '#find_executable' do
-  let(:execs)   { ['less', 'more'] }
-
-  subject(:pager) { described_class }
-
-  it 'finds available command' 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.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.find_executable).to be_nil
-  end
-
-  it "takes precedence over other commands" do
-    allow(pager).to receive(:command_exists?).with('more') { true }
-    expect(pager.find_executable('more')).to eql('more')
-  end
-
-  it "allows to query for available command" do
-    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
-    let(:execs) { [nil, "", "   ", "less"] }
-
-    it "does not error" do
-      allow(pager).to receive(:executables).and_return(execs)
-      allow(pager).to receive(:command_exists?).with('less') { true }
-      expect(pager.find_executable).to eql('less')
-    end
-  end
-
-  context "when given a multi-word executable" do
-    let(:execs) { ["diff-so-fancy | less --tabs=4 -RFX"] }
-
-    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.find_executable).to eql(execs.first)
-    end
-  end
-end

data/spec/unit/system/new_spec.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Pager::SystemPager, '#new' do
-  it "raises error if system paging is not supported" do
-    allow(TTY::Pager::SystemPager).to receive(:find_executable).and_return(nil)
-
-    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.")
-  end
-
-  it "accepts multiple commands" do
-    allow(TTY::Pager::SystemPager)
-      .to receive(:find_executable).and_return('more -r')
-
-    TTY::Pager::SystemPager.new(command: ['less -r', 'more -r'])
-
-    expect(TTY::Pager::SystemPager)
-      .to have_received(:find_executable).with('less -r', 'more -r')
-  end
-end

data/spec/unit/system/page_spec.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-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(:exec_available?).and_return(true)
-    output   = double(:output, :tty? => true)
-    pager    = described_class.new(output: output)
-    write_io = spy
-    pid      = 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(pid, any_args).and_return([1, status])
-
-    expect(pager.page(text)).to eq(true)
-    expect(write_io).to have_received(:write).with(text)
-    expect(write_io).to have_received(:close)
-  end
-end

data/tasks/console.rake

@@ -1,11 +0,0 @@
-# encoding: utf-8
-
-desc 'Load gem inside irb console'
-task :console do
-  require 'irb'
-  require 'irb/completion'
-  require_relative '../lib/tty-pager'
-  ARGV.clear
-  IRB.start
-end
-task :c => :console

data/tasks/coverage.rake

@@ -1,11 +0,0 @@
-# encoding: utf-8
-
-desc 'Measure code coverage'
-task :coverage do
-  begin
-    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
-    Rake::Task['spec'].invoke
-  ensure
-    ENV['COVERAGE'] = original
-  end
-end