kramdown-ansi 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd37ac254127e9b4654a9a7621159894bee90193506f2b30fad07e3db7978663
-  data.tar.gz: 9cf0fa562dd8e274b7fba315c85c9148082ba71afdaf5a9f11a4e2ba201787b9
+  metadata.gz: 321a4eec7c5e73169503bd328310cb2d9a87db5c324fe4932d5512b5b704f761
+  data.tar.gz: cc3a340e04a4dd934089112dcb9a15553f0120c5ee5e51cbf9e6507f3dc08fa6
 SHA512:
-  metadata.gz: 8e72c1899f5338ed596bd4dc6a367e9ed32d9eb3a1cdcbc9ec9c4b1476557934de5ac5706d63f85a77f73880ad6a0316a26a5b58f4768cf77aebcf0d9076cc1b
-  data.tar.gz: 7cdd5cde26c6e8a15975d75c867fa57b78fe07794b6a785802c6c5098fc6004a2b1a6b95d78eca4ad58df3c0ef214ffc5e2d4d4b27502d436a40db10b5711229
+  metadata.gz: 9edd4e208d70b903ca25eee9e6b634f95c56501975c014d095de2f696e53050c379837bb58147b8a9a4aeb474508c772400577bcbfc2a99bcd4d2f4d8d7dd275
+  data.tar.gz: e4887d5eab51e9badbb0f4e5c111aa99962a564ec7ec689e12aa2c3429948a305a5710c59cd1b07637536eab95ac68058a6304dae5fd7f62865cf69d1380d590

data/CHANGES.md

@@ -1,5 +1,25 @@
 # Changes
 
+## 2025-02-28 v0.0.3
+
+* Improve `all_images` testing
+    * Updated Docker RUN command to install build-base and yaml-dev packages.
+    * Updated `gem_hadar` development dependency to version ~> **1.20**.
+    * Removed gem update and install commands.
+    * Added Docker image for **3.4** Ruby version.
+* Improve documentation
+    * Added images of `md` and `git-md` output to README.
+    * Added new files `img/git-md.png` and `img/md.png`.
+    * Updated list of files in `kramdown-ansi.gemspec`.
+
+## 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/README.md

@@ -62,6 +62,10 @@ open a pager command like `less` or `more` and pipes its output into it.
 By setting the `PAGER` environment variable accordingly one can define a custom
 command for this purpose.
 
+The output of the `md` command can be seen in this screenshot:
+
+![md output](./img/md.png)
+
 ### The git-md executable
 
 The `git-md` executable is a git plugin that can be used to output markdown
@@ -85,6 +89,11 @@ pager command was defined setting `git config set core.pager FOO`, in which
 case the FOO command is used as a pager for all git commands including `git
 md`.
 
+The output of the `git md` command can be seen in this screenshot:
+
+![git md output](./img/git-md.png)
+
+
 ## Download
 
 The homepage of this library is located at
@@ -101,7 +110,7 @@ This software is licensed under the <i>MIT</i> license.
 
 ## Mandatory Kitten Image
 
-![cat](spec/assets/kitten.jpg)
+![cat](./spec/assets/kitten.jpg)
 
 ---
 

data/Rakefile

@@ -19,7 +19,7 @@ GemHadar do
     '.yardoc', 'doc', 'tags', 'errors.lst', 'cscope.out', 'coverage', 'tmp',
     'yard'
   package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
-     '.rspec', *Dir.glob('.github/**/*', File::FNM_DOTMATCH)
+    '.rspec', *Dir.glob('.github/**/*', File::FNM_DOTMATCH)
   readme      'README.md'
 
   executables << 'md' << 'git-md'

data/kramdown-ansi.gemspec

@@ -1,30 +1,30 @@
 # -*- encoding: utf-8 -*-
-# stub: kramdown-ansi 0.0.1 ruby lib
+# stub: kramdown-ansi 0.0.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "kramdown-ansi".freeze
-  s.version = "0.0.1".freeze
+  s.version = "0.0.3".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 = "2025-02-28"
   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]
   s.extra_rdoc_files = ["README.md".freeze, "lib/kramdown/ansi.rb".freeze, "lib/kramdown/ansi/pager.rb".freeze, "lib/kramdown/ansi/width.rb".freeze, "lib/kramdown/version.rb".freeze]
-  s.files = ["CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/git-md".freeze, "bin/md".freeze, "kramdown-ansi.gemspec".freeze, "lib/kramdown/ansi.rb".freeze, "lib/kramdown/ansi/pager.rb".freeze, "lib/kramdown/ansi/width.rb".freeze, "lib/kramdown/version.rb".freeze, "spec/assets/README.ansi".freeze, "spec/assets/kitten.jpg".freeze, "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]
+  s.files = ["CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/git-md".freeze, "bin/md".freeze, "img/git-md.png".freeze, "img/md.png".freeze, "kramdown-ansi.gemspec".freeze, "lib/kramdown/ansi.rb".freeze, "lib/kramdown/ansi/pager.rb".freeze, "lib/kramdown/ansi/width.rb".freeze, "lib/kramdown/version.rb".freeze, "spec/assets/README.ansi".freeze, "spec/assets/kitten.jpg".freeze, "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]
   s.homepage = "https://github.com/flori/kramdown-ansi".freeze
   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.6.2".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]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.19".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.20".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.4".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<debug>.freeze, [">= 0".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.3'
   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,13 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-ansi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Florian Frank
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +143,8 @@ files:
 - Rakefile
 - bin/git-md
 - bin/md
+- img/git-md.png
+- img/md.png
 - kramdown-ansi.gemspec
 - lib/kramdown/ansi.rb
 - lib/kramdown/ansi/pager.rb
@@ -159,7 +160,6 @@ homepage: https://github.com/flori/kramdown-ansi
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - Kramdown-ansi - Output markdown in the terminal with ANSI escape sequences
@@ -178,8 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Output markdown in the terminal with ANSI escape sequences
 test_files: