kramdown-ansi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd37ac254127e9b4654a9a7621159894bee90193506f2b30fad07e3db7978663
-  data.tar.gz: 9cf0fa562dd8e274b7fba315c85c9148082ba71afdaf5a9f11a4e2ba201787b9
+  metadata.gz: abe5c3ac6431c1a6f2997c3c1414aa57fbfdb1c8eb2938b0bb9b7c59273c33ce
+  data.tar.gz: c1baef27fc70c8b613f911e5d7c945d9b8739faa0ef3b95e1cf771d705606a0e
 SHA512:
-  metadata.gz: 8e72c1899f5338ed596bd4dc6a367e9ed32d9eb3a1cdcbc9ec9c4b1476557934de5ac5706d63f85a77f73880ad6a0316a26a5b58f4768cf77aebcf0d9076cc1b
-  data.tar.gz: 7cdd5cde26c6e8a15975d75c867fa57b78fe07794b6a785802c6c5098fc6004a2b1a6b95d78eca4ad58df3c0ef214ffc5e2d4d4b27502d436a40db10b5711229
+  metadata.gz: 46da2186b55e0974b27ee06bbc5432b98e3dc2df22077f6a48208888ff1024c387dceae1e0dfbf0a0e17137442b33e35662a52e70e666deb017f6e622750a042
+  data.tar.gz: d743a08d17ebb58d7e906bca24300e0effb75e44004d40cebf5cdb5039fa0cfe6b63387a6b958748eb757dadc1522dd463eb0235e0c3631f43784c2112ae80a4

data/CHANGES.md

@@ -1,5 +1,13 @@
 # Changes
 
+## 2024-12-08 v0.0.2
+
+* Added handling of `Interrupt` and `Errno::EPIPE` exceptions when using pager in `md` and `git-md` executables:
+  * Added require `'term/ansicolor'` to `Kramdown::ANSI::Pager`.
+  * Added rescue blocks in `Kramdown::ANSI::Pager.pager` to catch `Interrupt`, `Errno::EPIPE` exceptions.
+  * Added `pager_reset_screen` method to reset terminal screen by printing ANSI escape codes.
+  * Updated `spec/kramdown/ansi/pager_spec.rb` with tests for new functionality.
+
 ## 2024-10-31 v0.0.1
 
 * Strip CSI and OSC sequences in `Terminal::Table`:

data/kramdown-ansi.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: kramdown-ansi 0.0.1 ruby lib
+# stub: kramdown-ansi 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "kramdown-ansi".freeze
-  s.version = "0.0.1".freeze
+  s.version = "0.0.2".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-10-31"
+  s.date = "2024-12-08"
   s.description = "Kramdown::ANSI: A library for rendering Markdown(ish) documents with\nbeautiful ANSI escape sequences in the terminal.\n".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["md".freeze, "git-md".freeze]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "Kramdown-ansi - Output markdown in the terminal with ANSI escape sequences".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new("~> 3.1".freeze)
-  s.rubygems_version = "3.5.22".freeze
+  s.rubygems_version = "3.5.23".freeze
   s.summary = "Output markdown in the terminal with ANSI escape sequences".freeze
   s.test_files = ["spec/kramdown/ansi/pager_spec.rb".freeze, "spec/kramdown/ansi/width_spec.rb".freeze, "spec/kramdown/ansi_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 

data/lib/kramdown/ansi/pager.rb

@@ -1,4 +1,5 @@
 require 'tins/terminal'
+require 'term/ansicolor'
 
 module Kramdown::ANSI::Pager
   module_function
@@ -18,10 +19,16 @@ module Kramdown::ANSI::Pager
         IO.popen(my_pager, 'w') do |output|
           output.sync = true
           yield output
+        rescue Interrupt, Errno::EPIPE
+          pager_reset_screen
+          return nil
+        ensure
           output.close
         end
+        my_pager
       else
         yield STDOUT
+        nil
       end
     else
       return unless STDOUT.tty?
@@ -34,4 +41,11 @@ module Kramdown::ANSI::Pager
       end
     end
   end
+
+  # Resets the terminal screen by printing ANSI escape codes for reset, clear
+  # screen, move home and show cursor.
+  def pager_reset_screen
+    c = Term::ANSIColor
+    STDOUT.print c.reset, c.clear_screen, c.move_home, c.show_cursor
+  end
 end

data/lib/kramdown/version.rb

@@ -1,6 +1,6 @@
 module Kramdown
   # Kramdown version
-  VERSION         = '0.0.1'
+  VERSION         = '0.0.2'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/spec/kramdown/ansi/pager_spec.rb

@@ -38,14 +38,42 @@ RSpec.describe Kramdown::ANSI::Pager do
       it 'can output to the command for paging if enough lines' do
         expect(Tins::Terminal).to receive(:lines).and_return 25
         block_called = false
-        Kramdown::ANSI::Pager.pager(command: command, lines: 30) do |output|
+        result = Kramdown::ANSI::Pager.pager(command: command, lines: 30) do |output|
           expect(output).to be_a IO
           expect(output).not_to eq STDOUT
           block_called = true
         end
         expect(block_called).to eq true
+        expect(result).to eq command
       end
 
+      it 'closes output for Interrupt' do
+        expect(Tins::Terminal).to receive(:lines).and_return 25
+        block_called = false
+        expect_any_instance_of(IO).to receive(:sync=).and_raise Interrupt
+        expect_any_instance_of(IO).to receive(:close).and_call_original
+        expect(described_class).to receive(:pager_reset_screen)
+        result = Kramdown::ANSI::Pager.pager(command: command, lines: 30) do |output|
+          block_called = true
+        end
+        expect(block_called).to eq false
+        expect(result).to be_nil
+      end
+
+      it 'closes output for Errno::EPIPE' do
+        expect(Tins::Terminal).to receive(:lines).and_return 25
+        block_called = false
+        expect_any_instance_of(IO).to receive(:sync=).and_raise Errno::EPIPE
+        expect_any_instance_of(IO).to receive(:close).and_call_original
+        expect(described_class).to receive(:pager_reset_screen)
+        result = Kramdown::ANSI::Pager.pager(command: command, lines: 30) do |output|
+          block_called = true
+        end
+        expect(block_called).to eq false
+        expect(result).to be_nil
+      end
+
+
       it 'can output STDOUT if not enough lines' do
         expect(Tins::Terminal).to receive(:lines).and_return 25
         block_called = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-ansi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Output markdown in the terminal with ANSI escape sequences