mkmf-lite 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bb580c0250d33fdbd926c5f85c792e13015866a0c4d18e67aa4acf6b16491f9
-  data.tar.gz: 23d85c79fcb12a6030b812653e78fce81ed7d33fcfe1a4ef4d2200b919e26bfe
+  metadata.gz: f2bb0ebe67ed8844ab179b66b5818a0affe93ce2d762bca7a43b920161b7dfdb
+  data.tar.gz: 7d972aa186c36a84b613409ebc15c9223a21a2520f9565483976ae8d875bff0b
 SHA512:
-  metadata.gz: 73afcb819c629c2d88eb46aa52bdaab5dd43ebdd148259f3b72291490c0ddf311af9525d1dfabeb5d530e23576bb2161074964275689fe6f77193b706a863dd5
-  data.tar.gz: fa5c1b19b4697cb5481fcac641ae4ae86eb0b3a3b19f623f8336b251f6dd3962f78d96582952f687c1af4522dad0c59824c2adf1aea966da86d94969dc467ffe
+  metadata.gz: 6a5064c3121ff5d770339e482f0d1a6b42113c2f405ce1265886e122e9754eb58c1152028deb0662bf9c46ed25b8c7204c946cbf6c162346c522cc65431ac301
+  data.tar.gz: 00e32c33cfb6d7125ddb1c66151d1b775693a0705b07bf1e525ba5428574e9b4cca146ea52c02123ff485fb098aac4c919e2b24b69c7913971e4544ba0f4edf5

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.5.2 - 24-Mar-2022
+* Lots of rubocop updates and minor cleanup, including the addition of
+  rubocop and rubocop-rspec as deve dependencies.
+* Deprecation warning fixes (actually bug fixes for Ruby 3.2).
+
 ## 0.5.1 - 18-Dec-2020
 * Switch docs to markdown format because github isn't rendering rdoc properly.
 

data/Gemfile

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

data/README.md

@@ -4,11 +4,14 @@ A light version of mkmf designed for use within programs.
 ## Installation
 `gem install mkmf-lite`
 
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/mkmf-lite/main/certs/djberg96_pub.pem)`
+
 ## Prerequisites
 A C compiler somewhere on your system.
 
 ## Synopsis
-```
+```ruby
 require 'mkmf/lite'
 
 class System

data/Rakefile

@@ -1,14 +1,15 @@
 require 'rake'
 require 'rake/clean'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-CLEAN.include("**/*.gem", "**/*.rbc")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*.lock")
 
 namespace 'gem' do
   desc 'Create the mkmf-lite gem.'
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('mkmf-lite.gemspec'))
+    spec = Gem::Specification.load('mkmf-lite.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
     Gem::Package.build(spec)
   end
@@ -20,6 +21,8 @@ namespace 'gem' do
   end
 end
 
+RuboCop::RakeTask.new
+
 desc "Run the test suite"
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/mkmf/lite.rb

@@ -1,21 +1,28 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'rbconfig'
 require 'tmpdir'
 require 'open3'
 require 'ptools'
 
+# The Mkmf module serves as a namespace only.
 module Mkmf
+  # The Lite module scopes the Mkmf module to differentiate it from the
+  # Mkmf module in the standard library.
   module Lite
     # The version of the mkmf-lite library
-    MKMF_LITE_VERSION = '0.5.1'.freeze
+    MKMF_LITE_VERSION = '0.5.2'
 
     private
 
+    # rubocop:disable Layout/LineLength
     def cpp_command
       command = RbConfig::CONFIG['CC'] || RbConfig::CONFIG['CPP'] || File.which('cc') || File.which('gcc') || File.which('cl')
-      raise "Compiler not found" unless command
+      raise 'Compiler not found' unless command
       command
     end
+    # rubocop:enable Layout/LineLength
 
     def cpp_source_file
       'conftest.c'
@@ -53,7 +60,7 @@ module Mkmf
       if directories.empty?
         options = nil
       else
-        options = ""
+        options = ''
         directories.each{ |dir| options += "-I#{dir} " }
         options.rstrip!
       end
@@ -156,9 +163,7 @@ module Mkmf
       end
 
       headers = headers.flatten.uniq
-      headers = headers.map{ |h| "#include <#{h}>" }.join("\n")
-
-      headers
+      headers.map{ |h| "#include <#{h}>" }.join("\n")
     end
 
     # Create a temporary bit of C source code in the temp directory, and
@@ -177,11 +182,11 @@ module Mkmf
         stderr_orig = $stderr.dup
         stdout_orig = $stdout.dup
 
-        Dir.chdir(Dir.tmpdir){
-          File.open(cpp_source_file, 'w'){ |fh| fh.write(code) }
+        Dir.chdir(Dir.tmpdir) do
+          File.write(cpp_source_file, code)
 
-          command  = cpp_command + ' '
-          command += cpp_out_file + ' '
+          command  = "#{cpp_command} "
+          command += "#{cpp_out_file} "
           command += cpp_source_file
 
           # Temporarily close these
@@ -191,7 +196,7 @@ module Mkmf
           if system(command)
             $stdout.reopen(stdout_orig) # We need this back for open3 to work.
 
-            conftest = File::ALT_SEPARATOR ? "conftest.exe" : "./conftest.exe"
+            conftest = File::ALT_SEPARATOR ? 'conftest.exe' : './conftest.exe'
 
             Open3.popen3(conftest) do |stdin, stdout, stderr|
               stdin.close
@@ -199,12 +204,12 @@ module Mkmf
               result = stdout.gets.chomp.to_i
             end
           else
-            raise "Failed to compile source code with command '#{command}':\n===\n" + code + "==="
+            raise "Failed to compile source code with command '#{command}':\n===\n#{code}==="
           end
-        }
+        end
       ensure
-        File.delete(cpp_source_file) if File.exists?(cpp_source_file)
-        File.delete(cpp_out_file) if File.exists?(cpp_out_file)
+        File.delete(cpp_source_file) if File.exist?(cpp_source_file)
+        File.delete(cpp_out_file) if File.exist?(cpp_out_file)
         $stderr.reopen(stderr_orig)
         $stdout.reopen(stdout_orig)
       end
@@ -219,31 +224,31 @@ module Mkmf
     # Note that $stderr is temporarily redirected to the null device because
     # we don't actually care about the reason for failure.
     #
-    def try_to_compile(code, command_options=nil)
+    def try_to_compile(code, command_options = nil)
       begin
         boolean = false
         stderr_orig = $stderr.dup
         stdout_orig = $stdout.dup
 
-        Dir.chdir(Dir.tmpdir){
-          File.open(cpp_source_file, 'w'){ |fh| fh.write(code) }
+        Dir.chdir(Dir.tmpdir) do
+          File.write(cpp_source_file, code)
 
           if command_options
-            command  = cpp_command + ' ' + command_options + ' '
+            command  = "#{cpp_command} #{command_options} "
           else
-            command  = cpp_command + ' '
+            command  = "#{cpp_command} "
           end
 
-          command += cpp_out_file + ' '
+          command += "#{cpp_out_file} "
           command += cpp_source_file
 
           $stderr.reopen(IO::NULL)
           $stdout.reopen(IO::NULL)
           boolean = system(command)
-        }
+        end
       ensure
-        File.delete(cpp_source_file) if File.exists?(cpp_source_file)
-        File.delete(cpp_out_file) if File.exists?(cpp_out_file)
+        File.delete(cpp_source_file) if File.exist?(cpp_source_file)
+        File.delete(cpp_out_file) if File.exist?(cpp_out_file)
         $stdout.reopen(stdout_orig)
         $stderr.reopen(stderr_orig)
       end
@@ -254,7 +259,7 @@ module Mkmf
     # Slurp the contents of the template file for evaluation later.
     #
     def read_template(file)
-      IO.read(get_template_file(file))
+      File.read(get_template_file(file))
     end
 
     # Retrieve the path to the template +file+ name.

data/lib/mkmf-lite.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'mkmf/lite'

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.5.1'
+  spec.version    = '0.5.2'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -13,15 +13,19 @@ Gem::Specification.new do |spec|
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
   spec.add_dependency('ptools', '~> 1.4')
+  spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('rubocop-rspec')
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/mkmf-lite',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/mkmf-lite/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/mkmf-lite/blob/master/CHANGES.rdoc',
-    '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'
+    'homepage_uri'          => 'https://github.com/djberg96/mkmf-lite',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/mkmf-lite/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/mkmf-lite/blob/main/CHANGES.md',
+    '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',
+    'rubygems_mfa_required' => 'true'
   }
 
   spec.description = <<-EOF

data/spec/mkmf_lite_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ########################################################################
 # mkmf_lite_spec.rb
 #
@@ -7,7 +9,7 @@ require 'rubygems'
 require 'rspec'
 require 'mkmf/lite'
 
-describe Mkmf::Lite do
+RSpec.describe Mkmf::Lite do
   subject { Class.new{ |obj| obj.extend Mkmf::Lite } }
 
   let(:st_type)   { 'struct stat' }
@@ -15,120 +17,120 @@ describe Mkmf::Lite do
   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')
+  describe 'constants' do
+    example 'version information' do
+      expect(described_class::MKMF_LITE_VERSION).to eq('0.5.2')
       expect(described_class::MKMF_LITE_VERSION).to be_frozen
     end
   end
 
-  describe "have_header" do
-    example "have_header basic functionality" do
+  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)
+    example 'have_header returns expected boolean value' do
+      expect(subject.have_header('stdio.h')).to be(true)
+      expect(subject.have_header('foobar.h')).to be(false)
     end
 
-    example "have_header accepts an array of directories as a second argument" do
+    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
+  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)
+    example 'have_func with no arguments returns expected boolean value' do
+      expect(subject.have_func('abort')).to be(true)
+      expect(subject.have_func('abortxyz')).to be(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)
+    example 'have_func with arguments returns expected boolean value' do
+      expect(subject.have_func('printf', 'stdio.h')).to be(true)
+      expect(subject.have_func('printfx', 'stdio.h')).to be(false)
     end
 
-    example "have_func requires at least one argument" do
+    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
+    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
+  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)
+    example 'have_struct_member returns expected boolean value' do
+      expect(subject.have_struct_member(st_type, st_member, st_header)).to be(true)
+      expect(subject.have_struct_member(st_type, 'pw_bogus', st_header)).to be(false)
+      expect(subject.have_struct_member(st_type, st_member)).to be(false)
     end
 
-    example "have_struct_member requires at least two arguments" do
+    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
+    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
+  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
+    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
+    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
+    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
+    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
+  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
+    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
+    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
+    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
+    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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mkmf-lite
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ptools
@@ -51,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +79,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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,
@@ -99,10 +141,11 @@ licenses:
 metadata:
   homepage_uri: https://github.com/djberg96/mkmf-lite
   bug_tracker_uri: https://github.com/djberg96/mkmf-lite/issues
-  changelog_uri: https://github.com/djberg96/mkmf-lite/blob/master/CHANGES.rdoc
+  changelog_uri: https://github.com/djberg96/mkmf-lite/blob/main/CHANGES.md
   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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -118,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: A lighter version of mkmf designed for use as a library