mkmf-lite 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f47fa10fbba01d8138ccf00130db6de0a655ade9160bbf1f63c66a49f0180a85
-  data.tar.gz: 89ebf0df0a2ba2763f288f063766f886050e6cec2320875429499aeeb5f6697c
+  metadata.gz: 9473f0ca052ce32539ba3af2204a88c77f531e7bd4707a7199f7cfb4e55e700b
+  data.tar.gz: bc661abc68604445379cfaf8fdb56efa26b1b2b8c2162ac1d4f4d64922c8a36f
 SHA512:
-  metadata.gz: 5941960fbc5d1adbeda16c00cb056d75c816b07d5d9a361f62457dec029fe8bbb096957a7ce5b63ccf7220f12f0d97550e39a018e013c7d7309fbfe12cc8f020
-  data.tar.gz: aaf1b5436a3949512180a187909273fbf8c8738cb3f6bf46dad9c9e9b5707584b3db7a9ea9fceaba77384a2a904e58488f3621887f42ecdd848937ce3a8c134f
+  metadata.gz: 4b85efddc463304f178f995a34031524505c8f927b8546ea70186376b8263244d7dcd2ea7f162da376b73b53e2880dcda3a154a9db3367f8589c6a8c8e27560e
+  data.tar.gz: 6e0cf9e41d699e939001847ab41ef1f9d6aa3ab792666d294938b51d770471a6477b2a6a9a338dd76147c6cc6d0a685d859bd93925c82e72d71b325698e62524

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 0.9.1 - 7-Jul-2026
+* Updated function probes to avoid implicit declarations and old-style function
+  pointer syntax while preserving symbol-only checks.
+* Added a public diagnostics reader for the most recent compiler probe.
+* Improved value probe failures with captured compiler stdout, stderr, exit
+  status, command, and generated source.
+
 ## 0.9.0 - 5-Jul-2026
 * Added `Mkmf::Lite.configure` for process-wide compiler, include directory,
   library directory, compile flag, and link flag defaults.

data/README.md

@@ -63,11 +63,28 @@ an extension, does not write an `mkmf.log`, and keeps its API inside
 Boolean probes such as `have_header`, `have_func`, `have_library`, and
 `have_struct_member` are quiet by default and return `true` or `false`.
 
+After any probe compiles generated C, call `diagnostics` on the object that
+extends `Mkmf::Lite` to inspect the most recent compile attempt. It returns an
+object with `command`, `stdout`, `stderr`, `exit_status`, `source`, and
+`success?`.
+
 Value probes such as `check_valueof`, `check_sizeof`, and `check_offsetof`
 raise `StandardError` if their generated C cannot be compiled. The exception
-message includes the compiler command, compiler stderr, and generated source so
+message includes the compiler command, compiler output, and generated source so
 you can see what failed without hunting for a separate log file.
 
+```ruby
+class Probe
+  extend Mkmf::Lite
+
+  unless have_header('missing_header.h')
+    warn diagnostics.command.join(' ')
+    warn diagnostics.stderr
+    warn diagnostics.source
+  end
+end
+```
+
 ## FFI examples
 Use `mkmf-lite` to decide which declarations are safe to expose through FFI:
 

data/lib/mkmf/lite.rb

@@ -51,8 +51,22 @@ module Mkmf
       end
     end
 
+    # Captures the most recent compiler probe details for inspection.
+    Diagnostic = Struct.new(
+      :command,
+      :stdout,
+      :stderr,
+      :exit_status,
+      :source,
+      :keyword_init => true
+    ) do
+      def success?
+        exit_status == 0
+      end
+    end
+
     # The version of the mkmf-lite library
-    MKMF_LITE_VERSION = '0.9.0'
+    MKMF_LITE_VERSION = '0.9.1'
 
     class << self
       def configuration
@@ -159,6 +173,10 @@ module Mkmf
       Mkmf::Lite.configuration
     end
 
+    def diagnostics
+      @diagnostics
+    end
+
     # Check for the presence of the given +header+ file. You may optionally
     # provide a list of directories to search.
     #
@@ -180,6 +198,7 @@ module Mkmf
     # Returns true if found, or false if not found.
     #
     def have_func(function, headers = [])
+      headers_provided = !Array(headers).flatten.empty?
       headers = get_header_string(headers)
 
       erb_ptr = ERB.new(read_template('have_func_pointer.erb'))
@@ -188,9 +207,9 @@ module Mkmf
       ptr_code = erb_ptr.result(binding)
       std_code = erb_std.result(binding)
 
-      # Check for just the function pointer first. If that fails, then try
-      # to compile with the function declaration.
-      try_to_compile(ptr_code) || try_to_compile(std_code)
+      # Check for a header declaration first. If no headers were provided,
+      # fall back to an explicit declaration so symbol-only probes still work.
+      try_to_compile(ptr_code) || (!headers_provided && try_to_compile(std_code))
     end
 
     memoize :have_func
@@ -397,14 +416,14 @@ module Mkmf
           :output_file => output_file
         )
 
-        _stdout, stderr, status = Open3.capture3(*command)
+        stdout, stderr, status = Open3.capture3(*command)
+        store_diagnostics(command, stdout, stderr, status, code)
 
         if status.success?
           output, = Open3.capture2(output_file)
           result = output.chomp.to_i
         else
-          message = "Failed to compile source code with command '#{command.shelljoin}':\n#{stderr}===\n#{code}==="
-          raise StandardError, message
+          raise StandardError, diagnostic_message
         end
       end
 
@@ -427,11 +446,33 @@ module Mkmf
           :output_file => output_file
         )
 
-        _stdout, _stderr, status = Open3.capture3(*command)
+        stdout, stderr, status = Open3.capture3(*command)
+        store_diagnostics(command, stdout, stderr, status, code)
         status.success?
       end
     end
 
+    def store_diagnostics(command, stdout, stderr, status, source)
+      @diagnostics = Diagnostic.new(
+        :command => command.dup,
+        :stdout => stdout,
+        :stderr => stderr,
+        :exit_status => status.exitstatus,
+        :source => source
+      )
+    end
+
+    def diagnostic_message
+      [
+        "Failed to compile source code with command '#{diagnostics.command.shelljoin}':",
+        diagnostics.stderr,
+        diagnostics.stdout,
+        '===',
+        diagnostics.source,
+        '==='
+      ].reject(&:empty?).join("\n")
+    end
+
     # Slurp the contents of the template file for evaluation later.
     #
     def read_template(file)

data/lib/mkmf/templates/have_func.erb

@@ -1,10 +1,9 @@
 <%= headers %>
 
-int try_func(){
-  <%= function %>();
-  return 0;
-}
+extern void <%= function %>(void);
 
-int main(){
-  return 0;
+int main(void){
+  void (*volatile p)(void);
+  p = <%= function %>;
+  return p == 0;
 }

data/lib/mkmf/templates/have_func_pointer.erb

@@ -1,11 +1,7 @@
 <%= headers %>
 
-int check_for_function(){
-  void ((*volatile p)());
-  p = (void ((*)()))<%= function %>;
-  return 0;
-}
-
-int main(){
-  return 0;
+int main(void){
+  void (*volatile p)(void);
+  p = (void (*)(void))<%= function %>;
+  return p == 0;
 }

data/mkmf-lite.gemspec

@@ -3,7 +3,7 @@ require 'rubygems'
 Gem::Specification.new do |spec|
   spec.name       = 'mkmf-lite'
   spec.summary    = 'A lighter version of mkmf designed for use as a library'
-  spec.version    = '0.9.0'
+  spec.version    = '0.9.1'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'

data/spec/mkmf_lite_spec.rb

@@ -93,6 +93,31 @@ RSpec.describe Mkmf::Lite do
     end
   end
 
+  def missing_header
+    'mkmf_lite_missing_header.h'
+  end
+
+  def expect_failed_diagnostics_for(probe, source_text)
+    diagnostics = probe.diagnostics
+
+    expect(diagnostics.command).to be_a(Array)
+    expect(diagnostics.stdout).to be_a(String)
+    expect(diagnostics.stderr).to be_a(String)
+    expect(diagnostics.exit_status).to be_a(Integer)
+    expect(diagnostics.exit_status).not_to eq(0)
+    expect(diagnostics.source).to include(source_text)
+    expect(diagnostics).not_to be_success
+  end
+
+  def expect_value_probe_error(error, probe, source_text)
+    expect(error.message).to include(
+      'Failed to compile source code with command',
+      probe.diagnostics.command.shelljoin,
+      probe.diagnostics.stderr,
+      source_text
+    )
+  end
+
   let(:st_type)   { 'struct stat' }
   let(:st_member) { 'st_uid' }
   let(:st_header) { 'sys/stat.h' }
@@ -100,7 +125,7 @@ RSpec.describe Mkmf::Lite do
 
   describe 'constants' do
     example 'version information' do
-      expect(described_class::MKMF_LITE_VERSION).to eq('0.9.0')
+      expect(described_class::MKMF_LITE_VERSION).to eq('0.9.1')
       expect(described_class::MKMF_LITE_VERSION).to be_frozen
     end
   end
@@ -146,6 +171,22 @@ RSpec.describe Mkmf::Lite do
       expect(subject.have_func('printfx', 'stdio.h')).to be(false)
     end
 
+    example 'have_func supports symbol-only checks without caller-provided headers' do
+      skip('getpid is POSIX-specific') if File::ALT_SEPARATOR
+
+      expect(subject.have_func('getpid')).to be(true)
+    end
+
+    example 'have_func templates avoid implicit declarations and old-style prototypes' do
+      pointer_source = template_source('have_func_pointer.erb')
+      declaration_source = template_source('have_func.erb')
+
+      expect(pointer_source).to include('int main(void)', 'void (*volatile p)(void)')
+      expect(pointer_source).not_to include('(*)()', '<%= function %>();')
+      expect(declaration_source).to include('extern void <%= function %>(void)')
+      expect(declaration_source).not_to include('<%= function %>();')
+    end
+
     example 'have_func requires at least one argument' do
       expect{ subject.have_func }.to raise_error(ArgumentError)
     end
@@ -384,6 +425,34 @@ RSpec.describe Mkmf::Lite do
     end
   end
 
+  describe 'diagnostics' do
+    example 'starts with no diagnostics' do
+      expect(subject.diagnostics).to be_nil
+    end
+
+    example 'records failed boolean probes without printing output' do
+      probe = new_probe
+
+      expect{ expect(probe.have_header(missing_header)).to be(false) }.not_to output.to_stdout
+      expect_failed_diagnostics_for(probe, missing_header)
+    end
+
+    example 'records successful probe diagnostics' do
+      expect(subject.have_header('stdio.h')).to be(true)
+
+      expect(subject.diagnostics).to be_success
+      expect(subject.diagnostics.source).to include('stdio.h')
+    end
+
+    example 'uses captured diagnostics in value probe errors' do
+      token = 'mkmf_lite_missing_type'
+
+      expect{ subject.check_sizeof("struct #{token}") }.to raise_error(StandardError) { |error|
+        expect_value_probe_error(error, subject, token)
+      }
+    end
+  end
+
   describe 'parallel probe invocations' do
     example 'run independently without temporary file collisions' do
       results = Array.new(6) { Thread.new { parallel_probe_result } }.map(&:value)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mkmf-lite
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -136,7 +136,6 @@ files:
 - LICENSE
 - MANIFEST.md
 - README.md
-- ROADMAP.md
 - Rakefile
 - certs/djberg96_pub.pem
 - lib/mkmf-lite.rb

metadata.gz.sig

@@ -1,5 +1 @@
-�
-}��/�h��lC#�~�Ƞ5�	����Y�ЧH�l�)0~j�4Z�pY߷��	
-���Zq�e%��B���x��$P�Y��!w����	�.9���Q��
-�3S��񳕳�i���i�(n4
-;�x<�kS��L��������9��Ƚ�wAp8���(��i�c�1���O���o��49����
-�nGg���GI����B�)Ff\��!��Sa�ŢY�_ҞG"�6پ����!�_�wۘ��|y�������;k��e����Ǽϖh	�L΢��q�?0�l
+:�4��اmO-F�FkZ��.�������o��܇��ER������'5����Mނ�%�~�����h~J'SY�����.�B6h��7�s��u��I���y�FI��e�	i;�e�xK4V�o��z1KԒz�����CG%B,�:M�F��R�wR*5aԮSO\��9�F��v�d o�q����K����u]C�Ɠ`�����1a>��<ծT�yi����9��;U�zRX���i劤Rms�0�*��$	I��:��dR��J�x���Z�s�����rYkw'!���z���u�l�q��4ބ?AE&(͘��s�͝���\�
��

data/ROADMAP.md

@@ -1,150 +0,0 @@
-# Roadmap
-
-This branch focuses on improving `mkmf-lite` without turning it into stdlib
-`mkmf`. The guiding rule is to add clearer extension points and better
-diagnostics while preserving the small public API that existing callers use.
-
-## Released
-
-### 0.8.0 - Portability Foundation
-
-Released 29-Jun-2026.
-
-* Removed implicit Linux-style library flags from compiler probes.
-* Replaced shell-built compiler command strings with argv-style execution.
-* Used per-probe temporary directories instead of shared `conftest.c` and
-  `conftest.exe` files in `Dir.tmpdir`.
-* Avoided global `Dir.chdir` during probe compilation.
-* Captured compiler diagnostics internally.
-* Improved support for include directories with spaces.
-* Added FreeBSD CI coverage.
-
-## 0.9.0 - C Probe Correctness
-
-Improve the generated C probes first, keeping the Ruby API stable and avoiding
-changes that could surprise existing callers.
-
-### Generated C Types
-
-Improve generated C for sizes, offsets, and stricter compilers.
-
-Status: Done.
-
-* [x] Print `sizeof` results using `size_t` and `%zu`.
-* [x] Print `offsetof` results using `size_t` and `%zu`.
-* [x] Avoid casting sizes and offsets down to `int`.
-* [x] Review `check_valueof` output formatting for constants wider than `int`.
-* [x] Keep return values as Ruby integers.
-
-### Function Probes
-
-Review function detection under stricter C modes.
-
-* Avoid relying on implicit declarations.
-* Avoid old-style function assumptions where practical.
-* Keep support for checking functions with and without caller-provided headers.
-* Preserve the current boolean behavior of `have_func`.
-
-### Compile-Only Probes
-
-Prefer compile-time checks where a probe only needs success or failure.
-
-Status: Done.
-
-* [x] Consider compile-time assertions for struct member checks.
-* [x] Keep generated source small and readable for diagnostics.
-* [x] Avoid adding platform-specific C unless no portable form exists.
-
-### Diagnostics
-
-Make failed probes easier to understand without printing unexpected output.
-
-* Store the last compile command, stdout, stderr, exit status, and generated C
-  source for inspection.
-* Add a public diagnostics reader with a small stable shape.
-* Keep normal boolean probes quiet by default.
-* Improve raised errors from `check_valueof`, `check_sizeof`, and
-  `check_offsetof` with captured compiler output.
-
-### Tests
-
-Broaden tests around generated C, failure modes, and platform config.
-
-* [x] Add specs for `sizeof` and `offsetof` values that should not be truncated.
-* [x] Add specs for generated compiler/linker arguments.
-* [x] Test library names with and without a leading `lib` prefix.
-* [x] Test parallel probe invocations.
-* Add mocked `RbConfig` coverage for Linux, macOS, FreeBSD, Windows/MSVC, and
-  JRuby.
-* Add specs for captured diagnostics from failed probes.
-
-### Documentation
-
-Document the portability model and diagnostic behavior.
-
-Status: Done.
-
-* [x] Explain that probes compile tiny C programs using Ruby's configured compiler.
-* [x] Clarify how `mkmf-lite` differs from stdlib `mkmf`.
-* [x] Add FFI-oriented examples for common Unix-like use cases.
-* [x] Document memoization behavior and how it interacts with probe inputs.
-
-## Later
-
-### API Options
-
-Keyword arguments may be useful, but they should wait until the lower-level
-probe behavior is settled and the compatibility tradeoffs are clearer.
-
-* Add `include_dirs:` as a keyword alternative to positional include directory
-  arguments.
-* Add `lib_dirs:` for library search paths.
-* Add `cflags:` for extra compile flags.
-* Add `ldflags:` for extra link flags.
-* Keep existing positional forms compatible.
-* Make option handling consistent across `have_header`, `have_func`,
-  `have_library`, `have_struct_member`, `check_valueof`, `check_sizeof`, and
-  `check_offsetof`.
-
-Example target API:
-
-```ruby
-have_header('foo.h', include_dirs: ['/usr/local/include'])
-have_library(
-  'foo',
-  'foo_init',
-  headers: ['foo.h'],
-  lib_dirs: ['/usr/local/lib'],
-  cflags: ['-D_GNU_SOURCE']
-)
-```
-
-### Configuration
-
-Consider a small configuration API if repeated keyword arguments become noisy.
-
-Status: Done.
-
-* [x] Evaluate `Mkmf::Lite.configure` for global defaults.
-* [x] Support compiler, include directories, library directories, compile flags,
-  and link flags as possible defaults.
-* [x] Make configuration interaction with memoized probe results explicit.
-
-### 1.0.0 - Stable Contract
-
-Finalize the behavior expected by downstream users.
-
-* Document the supported public API and compatibility expectations.
-* Document compiler selection, probe memoization, error handling, and platform
-  support.
-* Keep the library focused on lightweight compile/link probes rather than
-  becoming a replacement for stdlib `mkmf`.
-
-### Dependency Reduction
-
-Reducing dependencies is useful, but should not distract from the 0.9 API work.
-
-* Remove `ptools` if it is only needed for `File.which`.
-* Replace `File.which` with a small internal executable lookup based on
-  `ENV['PATH']`.
-* Reevaluate `memoist` after the probe and command execution behavior is stable.