kramdown-ansi 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df9bedd2874bdb7a5df692fd4de8aa0f45c7229f34e52949c373f59a51029729
-  data.tar.gz: 815611deb77a20eeabfaff76f859607947139aee185aad9f87f2ea4eac8bdf30
+  metadata.gz: 657384fbba567a6cdedd1967e08e21d4ae22d47bb33ce02faf2909ae9658de6e
+  data.tar.gz: ec6b5e6cb7da4309f0630b00f0e6610f9d9e17f0596ac27187dfeaaa66a7c056
 SHA512:
-  metadata.gz: 140e9340a37b9a97fab71289203bac0cb5c2437ff1e0c5b89b78c7bdb4d10e2333475d0e939cfabed5a38127250b4651e1fdb3914396beb50a75c9982eb06de2
-  data.tar.gz: 1d71d051b792244a649e68af967f65d744985e74f99f03f2305415592d8beca583a6ad8035fbd8f24c404abf570fe8ec95f15540dfe416b93859974da31c18c1
+  metadata.gz: f2778dc227dbe7d171e1fc0e7c8155341172d07e28481d8971fb76ac9ef408dca723dcaa07f62637aaa8db8dd96fe8b6a62f06031c8201d414abe7d13b2a3c9d
+  data.tar.gz: 41dc68f850e1cd48ea2095a1415760b85ff18efac343b321dcd2b72ab37e4fe9291abd481b61dd9b5b249468176755dcf1bf52e5f6e7493a5d9ee8529e5bd621

data/CHANGES.md

@@ -1,5 +1,37 @@
 # Changes
 
+## 2025-12-09 v0.3.0
+
+- Added documentation link to README
+- Added GitHub Actions workflow file `.github/workflows/static.yml` for static
+  site deployment to GitHub Pages
+- Configured GitHub Actions workflow to run on `master` branch pushes and
+  manual dispatch with appropriate permissions
+- Implemented deployment job using `ubuntu-latest` runner with steps for
+  checkout, setup Pages, setup Ruby **3.4**, documentation generation, artifact
+  upload, and deployment
+- Updated `Rakefile` to include `github_workflows` configuration for the new
+  `static.yml` workflow
+- Updated gem dependencies in `kramdown-ansi.gemspec` to use RubyGems version
+  **3.7.2** instead of **3.6.9**
+- Updated `gem_hadar` development dependency from version **~> 2.6** to **~>
+  2.8**
+- Modified `lib/kramdown/ansi/pager.rb` to improve documentation and yield both
+  output stream and process ID to the block
+- Added new test case in `spec/kramdown/ansi/pager_spec.rb` to verify that the
+  `pager` method yields both output and pid to the block
+- Enhanced the `pager` method documentation to better describe its
+  functionality and parameters
+- Added `bundle install --jobs=$(getconf _NPROCESSORS_ONLN)` command to utilize
+  all available CPU cores during gem installation
+- Updated `gem_hadar` development dependency from version **2.2** to **2.6**
+- Modified `package_ignore` in `Rakefile` to explicitly ignore `.github`
+  directory instead of using glob pattern `'.github/**/*'`
+- Added `RUN gem update --system` to update RubyGems to **latest** version in
+  CI configuration
+- Added `bundle update` command to update bundle dependencies in CI
+  configuration
+
 ## 2025-09-09 v0.2.0
 
 - Updated required Ruby version requirement from **~> 3.0** to **~> 3.1**

data/README.md

@@ -5,6 +5,10 @@
 **Kramdown::ANSI**: A library for rendering Markdown(ish) documents with beautiful
 ANSI escape sequences _in the terminal_.
 
+## Documentation
+
+Complete API documentation is available at: [GitHub.io](https://flori.github.io/kramdown-ansi/)
+
 ## Installation (gem & bundler)
 
 To install Kramdown::ANSI, you can use the following methods:

data/Rakefile

@@ -19,11 +19,15 @@ 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', '.github'
   readme      'README.md'
 
   executables << 'md' << 'git-md'
 
+  github_workflows(
+    'static.yml' => {}
+  )
+
   required_ruby_version  '~> 3.1'
 
   dependency             'term-ansicolor',        '~> 1.11'

data/kramdown-ansi.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: kramdown-ansi 0.2.0 ruby lib
+# stub: kramdown-ansi 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "kramdown-ansi".freeze
-  s.version = "0.2.0".freeze
+  s.version = "0.3.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -18,13 +18,13 @@ 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.6.9".freeze
+  s.rubygems_version = "3.7.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/styles_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, ["~> 2.2".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.8".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

@@ -18,21 +18,25 @@ require 'term/ansicolor'
 module Kramdown::ANSI::Pager
   module_function
 
-  # If called without a block returns either the provided command for paging if
-  # the given number of lines are exceeding the available number of terminal
-  # lines or nil. If a block was provided it yields to an IO handle for the
-  # pager command in the latter case or STDOUT in the former.
+  # The pager method manages terminal output paging functionality
   #
-  # @param command [String] the pager command (optional)
-  # @param lines [Integer] the number of lines in the output (optional)
-  # @yield [IO] yields the output IO handle for further processing
-  # @return [NilClass] returns nil if STDOUT is used or STDOUT is not a TTY.
+  # This method handles the logic for determining when to use a pager command
+  # like 'less' or 'more' when the output exceeds the terminal's line capacity.
+  # It also manages the execution of these pagers and ensures proper terminal
+  # state restoration when paging is used.
+  #
+  # @param command [String] the pager command to use when paging is needed
+  # @param lines [Integer] the number of lines to compare against terminal height
+  # @yield [output, pid] when a block is provided, yields the output stream and child's process ID
+  # @yieldparam output [IO] the IO stream to write output to
+  # @yieldparam pid [Integer] the process ID of the pager subprocess
+  # @return [String, nil] the pager command string if paging was used, nil otherwise
   def pager(command: nil, lines: nil, &block)
     if block
       if my_pager = pager(command:, lines:)
         IO.popen(my_pager, 'w') do |output|
           output.sync = true
-          yield output
+          yield output, output.pid
         rescue Interrupt, Errno::EPIPE
           pager_reset_screen
           return nil

data/lib/kramdown/version.rb

@@ -1,6 +1,6 @@
 module Kramdown
   # Kramdown version
-  VERSION         = '0.2.0'
+  VERSION         = '0.3.0'
   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

@@ -47,6 +47,19 @@ describe Kramdown::ANSI::Pager do
         expect(result).to eq command
       end
 
+      it 'yields to output and pid' do
+        expect(Tins::Terminal).to receive(:lines).and_return 25
+        child_pid = nil
+        result = Kramdown::ANSI::Pager.pager(command: command, lines: 30) do |output, pid|
+          expect(pid).to be_a Integer
+          expect(output).to be_a IO
+          expect(output).not_to eq STDOUT
+          child_pid    = pid
+        end
+        expect(child_pid).to be_a Integer
+        expect(result).to eq command
+      end
+
       it 'closes output for Interrupt' do
         expect(Tins::Terminal).to receive(:lines).and_return 25
         block_called = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-ansi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Output markdown in the terminal with ANSI escape sequences
 test_files: