curb 0.8.5 → 1.3.6

data/Rakefile

@@ -2,10 +2,11 @@
 # 
 require 'rake/clean'
 require 'rake/testtask'
+require "ruby_memcheck"
+require 'shellwords'
 begin
-  require 'rdoc/task'
-rescue LoadError => e
-  require 'rake/rdoctask'
+require 'mixlib/shellout'
+rescue LoadError
 end
 
 CLEAN.include '**/*.o'
@@ -15,6 +16,15 @@ CLOBBER.include '**/*.log'
 CLOBBER.include '**/Makefile'
 CLOBBER.include '**/extconf.h'
 
+# Load support ruby and rake files (in this order)
+Dir.glob('tasks/*.rb').each { |r| load r}
+Dir.glob('tasks/*.rake').each { |r| load r}
+
+desc 'Print Ruby major version (ie "2_5")'
+task :ruby_version do
+  print current_ruby_major
+end
+
 def announce(msg='')
   $stderr.puts msg
 end
@@ -43,40 +53,31 @@ end
 make_program = (/mswin/ =~ RUBY_PLATFORM) ? 'nmake' : 'make'
 MAKECMD = ENV['MAKE_CMD'] || make_program
 MAKEOPTS = ENV['MAKE_OPTS'] || ''
-
 CURB_SO = "ext/curb_core.#{(defined?(RbConfig) ? RbConfig : Config)::MAKEFILE_CONFIG['DLEXT']}"
 
 file 'ext/Makefile' => 'ext/extconf.rb' do
-  Dir.chdir('ext') do
-    ruby "extconf.rb #{ENV['EXTCONF_OPTS']}"
-  end
+  shell(['ruby', 'extconf.rb', ENV['EXTCONF_OPTS'].to_s],
+        { :live_stdout => STDOUT , :cwd => "#{Dir.pwd}/ext" }
+       ).error!
 end
 
 def make(target = '')
-  Dir.chdir('ext') do 
-    pid = system("#{MAKECMD} #{MAKEOPTS} #{target}")
-    $?.exitstatus
-  end    
+  shell(["#{MAKECMD}", "#{MAKEOPTS}", "#{target}"].reject(&:empty?),
+        { :live_stdout => STDOUT, :cwd => "#{Dir.pwd}/ext" }
+       ).error!
 end
 
 # Let make handle dependencies between c/o/so - we'll just run it. 
 file CURB_SO => (['ext/Makefile'] + Dir['ext/*.c'] + Dir['ext/*.h']) do
-  m = make
-  fail "Make failed (status #{m})" unless m == 0
+  make
 end
 
 desc "Compile the shared object"
 task :compile => [CURB_SO]
 
-desc "Create the markdown file"
-task :markdown do
-  cp "README", "README.markdown"
-end
-
 desc "Install to your site_ruby directory"
-task :install => :alltests do
-  m = make 'install' 
-  fail "Make install failed (status #{m})" unless m == 0
+task :install do
+  make 'install'
 end
 
 # Test Tasks ---------------------------------------------------------
@@ -88,18 +89,65 @@ task :rmpid do
   FileUtils.rm_rf Dir.glob("tests/server_lock-*")
 end
 
+at_exit do
+  next unless defined?(Rake.application)
+
+  top_level_tasks = Rake.application.top_level_tasks
+  test_tasks = %w[default test ta tu alltests unittests bugtests test:valgrind]
+  should_cleanup = top_level_tasks.empty? || top_level_tasks.any? { |task| test_tasks.include?(task) }
+
+  FileUtils.rm_rf Dir.glob("tests/server_lock-*") if should_cleanup
+end
+
 if ENV['RELTEST']
   announce "Release task testing - not running regression tests on alltests"
   task :alltests => [:unittests]
 else
   task :alltests => [:unittests, :bugtests]
 end
-                    
+
+ruby_memcheck_config = { binary_name: 'curb_core' }
+ruby_version = Gem::Version.new(RUBY_VERSION)
+
+if RUBY_ENGINE == 'ruby' && ruby_version >= Gem::Version.new('4.0.4') && ruby_version < Gem::Version.new('4.1.0')
+  # Ruby 4.0.4+ reports fiber/block-handler VM stack accesses under Valgrind.
+  # Keep reporting errors that originate in curb_core, but filter Ruby-side noise.
+  ruby_memcheck_config[:filter_all_errors] = true
+  if RubyMemcheck::Configuration.instance_method(:initialize).parameters.any? { |type, name|
+       type == :key && name == :use_only_ruby_free_at_exit
+     }
+    ruby_memcheck_config[:use_only_ruby_free_at_exit] = false
+  end
+  ruby_memcheck_config[:skipped_ruby_functions] =
+    RubyMemcheck::Configuration::DEFAULT_SKIPPED_RUBY_FUNCTIONS + [
+      /\Arb_vm_frame_block_handler\z/
+    ]
+end
+
+RubyMemcheck.config(**ruby_memcheck_config)
+namespace :test do
+  RubyMemcheck::TestTask.new(valgrind: :compile) do|t|
+    t.test_files = FileList['tests/tc_*.rb']
+    t.verbose = false
+  end
+
+  desc 'Run the standalone leak trace helper'
+  task :leak_trace => :compile do
+    ruby_opts = Shellwords.split(ENV['LEAK_TRACE_OPTS'].to_s)
+    sh RbConfig.ruby, '-Ilib', '-Iext', 'tests/leak_trace.rb', *ruby_opts
+  end
+end
+
+Rake::Task['test:valgrind'].enhance([:rmpid]) do
+  Rake::Task[:rmpid].reenable
+  Rake::Task[:rmpid].invoke
+end
+
 Rake::TestTask.new(:unittests) do |t|
   t.test_files = FileList['tests/tc_*.rb']
   t.verbose = false
 end
-                          
+
 Rake::TestTask.new(:bugtests) do |t|
   t.test_files = FileList['tests/bug_*.rb']
   t.verbose = false
@@ -136,11 +184,21 @@ end
 # RDoc Tasks ---------------------------------------------------------
 desc "Create the RDOC documentation"
 task :doc do
-  ruby "doc.rb #{ENV['DOC_OPTS']}"
+  doc_opts = Shellwords.split(ENV.fetch('DOC_OPTS', ''))
+  unsupported_opts = doc_opts - ['--cpp']
+  fail "Unsupported DOC_OPTS: #{unsupported_opts.join(' ')}" unless unsupported_opts.empty?
+
+  ruby 'doc.rb', *doc_opts
 end
 
 desc "Publish the RDoc documentation to project web site"
 task :doc_upload => [ :doc ] do
+  begin
+    require 'rdoc/task'
+  rescue LoadError => e
+    require 'rake/rdoctask'
+  end
+
   if ENV['RELTEST']
     announce "Release Task Testing, skipping doc upload"
   else    
@@ -171,13 +229,13 @@ else
 
   desc 'Build gem'
   task :package => :gemspec do
-    require 'rubygems/specification'
+    require 'rubygems/package'
     spec_source = File.read File.join(File.dirname(__FILE__),'curb.gemspec')
     spec = nil
     # see: http://gist.github.com/16215
-    Thread.new { spec = eval("$SAFE = 3\n#{spec_source}") }.join
+    Thread.new { spec = eval("#{spec_source}") }.join
     spec.validate
-    Gem::Builder.new(spec).build
+    Gem::Package.build(spec)
   end
 
   task :static do

data/doc.rb

@@ -1,10 +1,35 @@
 require 'fileutils'
+require 'open3'
+require 'shellwords'
 include FileUtils
 
-begin
-  incflags = File.read('ext/Makefile')[/INCFLAGS\s*=\s*(.*)$/,1]
+def makefile_variables(path)
+  variables = {}
+
+  File.foreach(path) do |line|
+    line = line.chomp
+    variables[$1] = $2.strip if line =~ /\A([A-Za-z_]\w*)\s*=\s*(.*)\z/
+  end
+
+  variables
+end
+
+def expand_make_variables(value, variables, seen = [])
+  value.gsub(/\$\(([^)]+)\)/) do
+    key = Regexp.last_match(1)
+    raise ArgumentError, "unsupported Makefile variable in INCFLAGS: #{key}" unless variables.key?(key)
+    raise ArgumentError, "recursive Makefile variable in INCFLAGS: #{key}" if seen.include?(key)
+
+    expand_make_variables(variables[key], variables, seen + [key])
+  end
+end
+
+def makefile_incflags
+  variables = makefile_variables('ext/Makefile')
+  Shellwords.split(expand_make_variables(variables.fetch('INCFLAGS', ''), variables))
 rescue Errno::ENOENT
   $stderr.puts("No makefile found; run `rake ext/Makefile' first.")
+  []
 end
 
 pp_srcdir = 'ext'
@@ -15,26 +40,41 @@ mkdir(tmpdir)
 begin
   if ARGV.include?('--cpp') 
     begin
-      if `cpp --version` =~ /\(GCC\)/
+      cpp_version, status = Open3.capture2e('cpp', '--version')
+
+      if status.success? && cpp_version =~ /\(GCC\)/
         # gnu cpp
         $stderr.puts "Running GNU cpp over source"
+        incflags = makefile_incflags
         
-        Dir['ext/*.c'].each do |fn|
-          system("cpp -DRDOC_NEVER_DEFINED -C #{incflags} -o " +
-                 "#{File.join(tmpdir, File.basename(fn))} #{fn}")
+        Dir['ext/*.c'].sort.each do |fn|
+          out = File.join(tmpdir, File.basename(fn))
+          abort "cpp failed for #{fn}" unless system('cpp', '-DRDOC_NEVER_DEFINED', '-C', *incflags, '-o', out, fn)
         end
         
         pp_srcdir = tmpdir
       else
         $stderr.puts "Not running cpp (non-GNU)"
       end
-    rescue
+    rescue Errno::ENOENT
       # no cpp          
       $stderr.puts "No cpp found"
+    rescue ArgumentError => e
+      abort e.message
     end
   end
  
-  system("rdoc --title='Curb - libcurl bindings for ruby' --main=README #{pp_srcdir}/*.c README LICENSE lib/curb.rb")
+  main = File.exist?('README.md') ? 'README.md' : 'README'
+  sources = Dir[File.join(pp_srcdir, '*.c')].sort
+  abort 'rdoc failed' unless system(
+    'rdoc',
+    '--title', 'Curb - libcurl bindings for ruby',
+    '--main', main,
+    *sources,
+    main,
+    'LICENSE',
+    'lib/curb.rb'
+  )
 ensure
   rm_rf(tmpdir)
 end

data/ext/banned.h

@@ -0,0 +1,32 @@
+#ifndef BANNED_H
+#define BANNED_H
+
+/*
+ * This header lists functions that have been banned from our code base,
+ * because they're too easy to misuse (and even if used correctly,
+ * complicate audits). Including this header turns them into compile-time
+ * errors.
+ */
+
+#define BANNED(func) sorry_##func##_is_a_banned_function
+
+#undef strcpy
+#define strcpy(x,y) BANNED(strcpy)
+#undef strcat
+#define strcat(x,y) BANNED(strcat)
+#undef strncpy
+#define strncpy(x,y,n) BANNED(strncpy)
+#undef strncat
+#define strncat(x,y,n) BANNED(strncat)
+
+#undef sprintf
+#undef vsprintf
+#ifdef HAVE_VARIADIC_MACROS
+#define sprintf(...) BANNED(sprintf)
+#define vsprintf(...) BANNED(vsprintf)
+#else
+#define sprintf(buf,fmt,arg) BANNED(sprintf)
+#define vsprintf(buf,fmt,arg) BANNED(sprintf)
+#endif
+
+#endif /* BANNED_H */