mkmf-lite 0.3.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de796a0bf860b6d6b4a7c21554977316e0ea07d4dfc03a3c7fc907d1ee0a68f9
-  data.tar.gz: dc854961978a892591511f5359ea95dbd5cd09739b8be4a577dc4afdb3d19b6b
+  metadata.gz: 7bb580c0250d33fdbd926c5f85c792e13015866a0c4d18e67aa4acf6b16491f9
+  data.tar.gz: 23d85c79fcb12a6030b812653e78fce81ed7d33fcfe1a4ef4d2200b919e26bfe
 SHA512:
-  metadata.gz: 81541850a6fc87d563b90feeb428bb587d0958f6440fcabe68e3719ef85f546bad732553da1a7aa565ba6b1eefec05774fbdbf2da19c15245aaa9bbeac82e0db
-  data.tar.gz: 55e3a0961fce9355ef96cc6a7fb32b2ccfc05deee2700d250051c7b826fca091cbc76c252f5bc5ab958e36ddd81614acf5af42ec3defb4da9d7d81301930318f
+  metadata.gz: 73afcb819c629c2d88eb46aa52bdaab5dd43ebdd148259f3b72291490c0ddf311af9525d1dfabeb5d530e23576bb2161074964275689fe6f77193b706a863dd5
+  data.tar.gz: fa5c1b19b4697cb5481fcac641ae4ae86eb0b3a3b19f623f8336b251f6dd3962f78d96582952f687c1af4522dad0c59824c2adf1aea966da86d94969dc467ffe

data/{CHANGES.rdoc → CHANGES.md}

@@ -1,29 +1,46 @@
-== 0.3.2 - 19-Mar-2020
+## 0.5.1 - 18-Dec-2020
+* Switch docs to markdown format because github isn't rendering rdoc properly.
+
+## 0.5.0 - 6-Dec-2020
+* Added the check_valueof method.
+
+## 0.4.2 - 31-Aug-2020
+* Did I say I didn't need ptools? Well I was wrong. It's back.
+
+## 0.4.1 - 31-Aug-2020
+* Removed the ptools dependency, just use IO::NULL.
+
+## 0.4.0 - 4-Jul-2020
+* Replaced test-unit with rspec, rewrote the tests, and made relevant
+  changes to the gemspec, etc.
+* Pinned the ptools version to 1.3.x.
+
+## 0.3.2 - 19-Mar-2020
 * Properly include a LICENSE file as per the Apache-2.0 license.
 
-== 0.3.1 - 11-Dec-2019
+## 0.3.1 - 11-Dec-2019
 * Added .rdoc extension to various text files so that they render more nicely
   on github.
 
-== 0.3.0 - 6-Jan-2019
+## 0.3.0 - 6-Jan-2019
 * Changed license to Apache-2.0.
 * Replaced class variables with methods.
 * Updated cert.
 
-== 0.2.6 - 6-Sep-2015
+## 0.2.6 - 6-Sep-2015
 * Added an mkmf-lite.rb file for convenience.
 * Assume Rubygems 2.x.
 * This gem is now signed.
 
-== 0.2.5 - 2-Oct-2014
+## 0.2.5 - 2-Oct-2014
 * The CC command for mingw now defaults to searching your path rather than
   relying on an environment variable because it wasn't trustworthy.
 * Updated the gem:install task for Rubygems 2.x.
 
-== 0.2.4 - 7-Mar-2013
+## 0.2.4 - 7-Mar-2013
 * The have_header method now accepts an optional list of directories to search.
 
-== 0.2.3 - 25-Apr-2012
+## 0.2.3 - 25-Apr-2012
 * No longer assumes mingw/gcc on Windows. Now passes all tests with a
   version of Ruby compiled with MSVC++.
 * Eliminate Config vs RbConfig warnings in 1.9.3.
@@ -31,17 +48,17 @@
   result in unwanted output.
 * Upgraded test-unit prerequisite to 2.4.0 or later.
 
-== 0.2.2 - 6-Dec-2011
+## 0.2.2 - 6-Dec-2011
 * Added the check_sizeof method.
 * If CONFIG['COMMON_HEADERS'] is blank then stdio.h and stdlib.h are
   used instead. On MS Windows the windows.h header is also used.
 
-== 0.2.1 - 21-Jan-2011
+## 0.2.1 - 21-Jan-2011
 * Minor platform detection adjustments for MS Windows.
 
-== 0.2.0 - 8-Jun-2010
+## 0.2.0 - 8-Jun-2010
 * Now works properly with JRuby (though it still requires a compiler
   somewhere on your system).
 
-== 0.1.0 - 24-May-2010
+## 0.1.0 - 24-May-2010
 * Initial release.

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org' do
+  gem 'rake'
+  gem 'ptools', '~> 1.4'
+  group 'test' do
+    gem 'rspec', '~> 3.9'
+  end
+end

data/{MANIFEST.rdoc → MANIFEST.md}

@@ -1,13 +1,14 @@
 * CHANGES.rdoc
 * LICENSE
 * MANIFEST.rdoc
-* README.rdoc
 * Rakefile
 * mkmf-lite.gemspec
 * certs/djberg96_pub.pem
 * lib/mkmf/lite.rb
+* lib/mkmf/templates/check_sizeof.erb
+* lib/mkmf/templates/check_valueof.erb
 * lib/mkmf/templates/have_func.erb
 * lib/mkmf/templates/have_func_pointer.erb
 * lib/mkmf/templates/have_header.erb
 * lib/mkmf/templates/have_struct_member.erb
-* test/test_mkmf_lite.rb
+* spec/mkmf_lite_spec.rb

data/{README.rdoc → README.md}

@@ -1,28 +1,30 @@
-== Summary
+## Summary
 A light version of mkmf designed for use within programs.
 
-== Installation
-  gem install mkmf-lite
+## Installation
+`gem install mkmf-lite`
 
-== Prerequisites
+## Prerequisites
 A C compiler somewhere on your system.
 
-== Synopsis
-  require 'mkmf/lite'
+## Synopsis
+```
+require 'mkmf/lite'
 
-  class System
-    extend Mkmf::Lite
+class System
+  extend Mkmf::Lite
 
-    HAVE_PW_NAME = have_struct_member('struct passwd', 'pw_name', 'pwd.h')
+  HAVE_PW_NAME = have_struct_member('struct passwd', 'pw_name', 'pwd.h')
 
-    def some_method
-      if HAVE_PW_NAME
-        # Do something
-      end
+  def some_method
+    if HAVE_PW_NAME
+      # Do something
     end
   end
+end
+```
 
-== Description
+## Description
 The mkmf library that ships as part of the Ruby standard library is not
 meant for use as an internal library. It's strictly designed for building
 C extensions. It's huge, its methods sit in a global namespace, it contains
@@ -36,24 +38,24 @@ used in conjunction with FFI. Also, the source code is quite readable.
 It does not package C extensions, nor generate a log file or a Makefile. It
 does, however, require that you have a C compiler somewhere on your system.
 
-== Known Issues
+## Known Issues
 You may see this warning from JRuby 1.4.x and earlier:
 
 warning: Useless use of a variable in void context.
 
 You can ignore these (or, upgrade your Jruby).
 
-== License
+## License
 Apache-2.0
 
-== Copyright
-(C) 2010-2019 Daniel J. Berger
+## Copyright
+(C) 2010-2020 Daniel J. Berger
 All Rights Reserved
 
-== Warranty
+## Warranty
 This library is provided "as is" and without any express or
 implied warranties, including, without limitation, the implied
 warranties of merchantability and fitness for a particular purpose.
 
-== Author
-Daniel Berger
+## Author
+Daniel J. Berger

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
 CLEAN.include("**/*.gem", "**/*.rbc")
 
@@ -20,9 +20,7 @@ namespace 'gem' do
   end
 end
 
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = true
-end
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/lib/mkmf/lite.rb

@@ -1,13 +1,13 @@
 require 'erb'
 require 'rbconfig'
 require 'tmpdir'
-require 'ptools'
 require 'open3'
+require 'ptools'
 
 module Mkmf
   module Lite
     # The version of the mkmf-lite library
-    MKMF_LITE_VERSION = '0.3.2'.freeze
+    MKMF_LITE_VERSION = '0.5.1'.freeze
 
     private
 
@@ -95,6 +95,20 @@ module Mkmf
       try_to_compile(code)
     end
 
+    # Returns the value of the given +constant+ (which could also be a macro)
+    # using +headers+, or common headers if no headers are specified.
+    #
+    # If this method fails an error is raised. This could happen if the constant
+    # can't be found and/or the header files do not include the indicated constant.
+    #
+    def check_valueof(constant, headers = [])
+      headers = get_header_string(headers)
+      erb = ERB.new(read_template('check_valueof.erb'))
+      code = erb.result(binding)
+
+      try_to_execute(code)
+    end
+
     # Returns the sizeof +type+ using +headers+, or common headers if no
     # headers are specified.
     #
@@ -171,8 +185,8 @@ module Mkmf
           command += cpp_source_file
 
           # Temporarily close these
-          $stderr.reopen(File.null)
-          $stdout.reopen(File.null)
+          $stderr.reopen(IO::NULL)
+          $stdout.reopen(IO::NULL)
 
           if system(command)
             $stdout.reopen(stdout_orig) # We need this back for open3 to work.
@@ -223,8 +237,8 @@ module Mkmf
           command += cpp_out_file + ' '
           command += cpp_source_file
 
-          $stderr.reopen(File.null)
-          $stdout.reopen(File.null)
+          $stderr.reopen(IO::NULL)
+          $stdout.reopen(IO::NULL)
           boolean = system(command)
         }
       ensure

data/lib/mkmf/templates/check_valueof.erb

@@ -0,0 +1,8 @@
+#include <stdio.h>
+
+<%= headers %>
+
+int main(){
+  printf("%d\n", <%= constant %>);
+  return 0;
+}

data/mkmf-lite.gemspec

@@ -3,19 +3,17 @@ 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.3.2'
+  spec.version    = '0.5.1'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'http://github.com/djberg96/mkmf-lite'
-  spec.test_file  = 'test/test_mkmf_lite.rb'
+  spec.test_file  = 'spec/mkmf_lite_spec.rb'
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
-  spec.extra_rdoc_files = Dir['*.rdoc']
-   
-  spec.add_dependency('ptools')
-  spec.add_development_dependency('test-unit', '>= 2.4.0')
+  spec.add_dependency('ptools', '~> 1.4')
+  spec.add_development_dependency('rspec', '~> 3.9')
 
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/mkmf-lite',

data/spec/mkmf_lite_spec.rb

@@ -0,0 +1,137 @@
+########################################################################
+# mkmf_lite_spec.rb
+#
+# Tests for the mkmf-lite library.
+########################################################################
+require 'rubygems'
+require 'rspec'
+require 'mkmf/lite'
+
+describe Mkmf::Lite do
+  subject { Class.new{ |obj| obj.extend Mkmf::Lite } }
+
+  let(:st_type)   { 'struct stat' }
+  let(:st_member) { 'st_uid' }
+  let(:st_header) { 'sys/stat.h' }
+  let(:constant)  { 'EOF' }
+
+  describe "constants" do
+    example "version information" do
+      expect(described_class::MKMF_LITE_VERSION).to eq('0.5.1')
+      expect(described_class::MKMF_LITE_VERSION).to be_frozen
+    end
+  end
+
+  describe "have_header" do
+    example "have_header basic functionality" do
+      expect(subject).to respond_to(:have_header)
+    end
+
+    example "have_header returns expected boolean value" do
+      expect(subject.have_header('stdio.h')).to eq(true)
+      expect(subject.have_header('foobar.h')).to eq(false)
+    end
+
+    example "have_header accepts an array of directories as a second argument" do
+      expect{ subject.have_header('stdio.h', '/usr/local/include') }.not_to raise_error
+      expect{ subject.have_header('stdio.h', '/usr/local/include', '/usr/include') }.not_to raise_error
+    end
+  end
+
+  context "have_func" do
+    example "have_func basic functionality" do
+      expect(subject).to respond_to(:have_func)
+    end
+
+    example "have_func with no arguments returns expected boolean value" do
+      expect(subject.have_func('abort')).to eq(true)
+      expect(subject.have_func('abortxyz')).to eq(false)
+    end
+
+    example "have_func with arguments returns expected boolean value" do
+      expect(subject.have_func('printf', 'stdio.h')).to eq(true)
+      expect(subject.have_func('printfx', 'stdio.h')).to eq(false)
+    end
+
+    example "have_func requires at least one argument" do
+      expect{ subject.have_func }.to raise_error(ArgumentError)
+    end
+
+    example "have_func accepts a maximum of two arguments" do
+      expect{ subject.have_func('printf', 'stdio.h', 'bogus') }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "have_struct_member" do
+    example "have_struct_member basic functionality" do
+      expect(subject).to respond_to(:have_struct_member)
+    end
+
+    example "have_struct_member returns expected boolean value" do
+      expect(subject.have_struct_member(st_type, st_member, st_header)).to eq(true)
+      expect(subject.have_struct_member(st_type, 'pw_bogus', st_header)).to eq(false)
+      expect(subject.have_struct_member(st_type, st_member)).to eq(false)
+    end
+
+    example "have_struct_member requires at least two arguments" do
+      expect{ subject.have_struct_member() }.to raise_error(ArgumentError)
+      expect{ subject.have_struct_member('struct passwd') }.to raise_error(ArgumentError)
+    end
+
+    example "have_struct_member accepts a maximum of three arguments" do
+      expect{ subject.have_struct_member('struct passwd', 'pw_name', 'pwd.h', true) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "check_valueof" do
+    example "check_valueof basic functionality" do
+      expect(subject).to respond_to(:check_valueof)
+      expect{ subject.check_sizeof(constant) }.not_to raise_error
+    end
+
+    example "check_valueof requires at least one argument" do
+      expect{ subject.check_valueof }.to raise_error(ArgumentError)
+    end
+
+    example "check_valueof accepts a maximum of two arguments" do
+      expect{ subject.check_valueof(constant, 'stdio.h', 1) }.to raise_error(ArgumentError)
+    end
+
+    example "check_valueof works with one or two arguments" do
+      expect{ subject.check_valueof(constant) }.not_to raise_error
+      expect{ subject.check_valueof(constant, 'stdio.h') }.not_to raise_error
+    end
+
+    example "check_valueof returns an integer value" do
+      value = subject.check_valueof(constant)
+      expect(value).to be_kind_of(Integer)
+      expect(value).to eq(-1)
+    end
+  end
+
+  context "check_sizeof" do
+    example "check_sizeof basic functionality" do
+      expect(subject).to respond_to(:check_sizeof)
+      expect{ subject.check_sizeof(st_type, st_header) }.not_to raise_error
+    end
+
+    example "check_sizeof requires at least one argument" do
+      expect{ subject.check_sizeof }.to raise_error(ArgumentError)
+    end
+
+    example "check_sizeof accepts a maximum of two arguments" do
+      expect{ subject.check_sizeof('div_t', 'stdlib.h', 1) }.to raise_error(ArgumentError)
+    end
+
+    example "check_sizeof works with one or two arguments" do
+      expect{ subject.check_sizeof('div_t') }.not_to raise_error
+      expect{ subject.check_sizeof('div_t', 'stdlib.h') }.not_to raise_error
+    end
+
+    example "check_sizeof returns an integer value" do
+      size = subject.check_sizeof(st_type, st_header)
+      expect(size).to be_kind_of(Integer)
+      expect(size).to be > 0
+    end
+  end
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: mkmf-lite
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,36 +35,36 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ptools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.9'
 description: |2
       The mkmf-lite library is a light version of the the mkmf library
       designed for use as a library. It does not create packages, builds,
@@ -74,26 +74,25 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- CHANGES.rdoc
-- MANIFEST.rdoc
-- README.rdoc
+extra_rdoc_files: []
 files:
-- CHANGES.rdoc
+- CHANGES.md
+- Gemfile
 - LICENSE
-- MANIFEST.rdoc
-- README.rdoc
+- MANIFEST.md
+- README.md
 - Rakefile
 - certs/djberg96_pub.pem
 - lib/mkmf-lite.rb
 - lib/mkmf/lite.rb
 - lib/mkmf/templates/check_sizeof.erb
+- lib/mkmf/templates/check_valueof.erb
 - lib/mkmf/templates/have_func.erb
 - lib/mkmf/templates/have_func_pointer.erb
 - lib/mkmf/templates/have_header.erb
 - lib/mkmf/templates/have_struct_member.erb
 - mkmf-lite.gemspec
-- test/test_mkmf_lite.rb
+- spec/mkmf_lite_spec.rb
 homepage: http://github.com/djberg96/mkmf-lite
 licenses:
 - Apache-2.0
@@ -104,7 +103,7 @@ metadata:
   documentation_uri: https://github.com/djberg96/mkmf-lite/wiki
   source_code_uri: https://github.com/djberg96/mkmf-lite
   wiki_uri: https://github.com/djberg96/mkmf-lite/wiki
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,9 +118,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A lighter version of mkmf designed for use as a library
 test_files:
-- test/test_mkmf_lite.rb
+- spec/mkmf_lite_spec.rb

data/test/test_mkmf_lite.rb

@@ -1,119 +0,0 @@
-########################################################################
-# test_mkmf_lite.rb
-#
-# Tests for the mkmf-lite library.
-########################################################################
-require 'rubygems'
-require 'test-unit'
-require 'mkmf/lite'
-
-class TC_Mkmf_Lite < Test::Unit::TestCase
-  include Mkmf::Lite
-
-  def self.startup
-    @@windows = File::ALT_SEPARATOR
-  end
-
-  def setup
-    @st_type   = 'struct stat'
-    @st_member = 'st_uid'
-    @st_header = 'sys/stat.h'
-  end
-
-  test "version information" do
-    assert_equal('0.3.2', MKMF_LITE_VERSION)
-    assert_true(MKMF_LITE_VERSION.frozen?)
-  end
-
-  test "have_header basic functionality" do
-    assert_respond_to(self, :have_header)
-  end
-
-  test "have_header returns expected boolean value" do
-    assert_true(have_header('stdio.h'))
-    assert_false(have_header('foobar.h'))
-  end
-
-  test "have_header accepts an array of directories as a second argument" do
-    assert_nothing_raised{ have_header('stdio.h', '/usr/local/include') }
-    assert_nothing_raised{ have_header('stdio.h', '/usr/local/include', '/usr/include') }
-  end
-
-  test "have_func basic functionality" do
-    assert_respond_to(self, :have_func)
-  end
-
-  test "have_func with no arguments returns expected boolean value" do
-    assert_true(have_func('abort'))
-    assert_false(have_func('abortxyz'))
-  end
-
-  test "have_func with arguments returns expected boolean value" do
-    assert_true(have_func('printf', 'stdio.h'))
-    assert_false(have_func('printfx', 'stdio.h'))
-  end
-
-  test "have_func requires at least one argument" do
-    assert_raise(ArgumentError){ have_func }
-  end
-
-  test "have_func accepts a maximum of two arguments" do
-    assert_raise(ArgumentError){ have_func('printf', 'stdio.h', 'bogus') }
-  end
-
-  test "have_struct_member basic functionality" do
-    assert_respond_to(self, :have_struct_member)
-  end
-
-  test "have_struct_member returns expected boolean value" do
-    assert_true(have_struct_member(@st_type, @st_member, @st_header))
-    assert_false(have_struct_member(@st_type, 'pw_bogus', @st_header))
-    assert_false(have_struct_member(@st_type, @st_member))
-  end
-
-  test "have_struct_member requires at least two arguments" do
-    assert_raise(ArgumentError){ have_struct_member() }
-    assert_raise(ArgumentError){ have_struct_member('struct passwd') }
-  end
-
-  test "have_struct_member accepts a maximum of three arguments" do
-    assert_raise(ArgumentError){
-      have_struct_member('struct passwd', 'pw_name', 'pwd.h', true)
-    }
-  end
-
-  test "check_sizeof basic functionality" do
-    assert_respond_to(self, :check_sizeof)
-    assert_nothing_raised{ check_sizeof(@st_type, @st_header) }
-  end
-
-  test "check_sizeof requires at least one argument" do
-    assert_raise(ArgumentError){ check_sizeof }
-    assert_raise(ArgumentError){ check_sizeof('struct passwd', 'pw_name', 1) }
-  end
-
-  test "check_sizeof accepts a maximum of two arguments" do
-    assert_raise(ArgumentError){ check_sizeof('div_t', 'stdlib.h', 1) }
-  end
-
-  test "check_sizeof works with one or two arguments" do
-    assert_nothing_raised{ check_sizeof('div_t') }
-    assert_nothing_raised{ check_sizeof('div_t', 'stdlib.h') }
-  end
-
-  test "check_sizeof returns an integer value" do
-    size = check_sizeof(@st_type, @st_header)
-    assert_kind_of(Integer, size)
-    assert_true(size > 0)
-  end
-
-  def teardown
-    @st_type   = nil
-    @st_member = nil
-    @st_header = nil
-  end
-
-  def self.shutdown
-    @@windows = nil
-  end
-end