hoe 3.17.2 → 3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d643abe62254c9b7e7aeec57098bd6d9eda8489201fb9a20e7d757c0a2cab699
-  data.tar.gz: 04b5b24927f2130264b78b92d4be8d9a402005d430e6f96695aafc3c3e519e9f
+  metadata.gz: 6de30da4ab3f81bb05f71c363bcb5abc4e17135adf2a0aa0eb24d4b10952eee3
+  data.tar.gz: 52ac3b48a9624a5be58e573b13857556355e7021aff97ded7543080e4dcf6ca6
 SHA512:
-  metadata.gz: d60591f0c0b9e1cdcf7e8ae96ab9df7361ed91dbd571be49290b8e2d1662570643a4a2314ee8aaa0f52aeb9f85b80489756519593d93fadbecebed61c23410cc
-  data.tar.gz: 89b3f5dfd0fe5ee805aceb8bb85af930100f8b5323d97aa7cfa8aa4083c40908e4521c5321af2c1aa7b6fe40a5975b56472c033df96d398b55a356015cbe0559
+  metadata.gz: 7388568d21b94b2810df22b5f4aba3b4566fc2fbcb3623bf58d814d3f180a0b3aed5a279f3be16081290e71994eb07a307dd83ec81f15d87e59bc227af888c9d
+  data.tar.gz: 7dbe503b0ba399504992d404e4d4591f8266fd881ce02571b37ea655a97b5456ffdb5aca7bd3a9a076d2b7d60781c030f5ba2471424f104071a7710cac0d5fd8

data/History.rdoc

@@ -1,3 +1,24 @@
+=== 3.18.0 / 2019-05-25
+
+* 1 major enhancement:
+
+  * Added Minitest::TestTask (will move to minitest proper soon)
+
+* 8 minor enhancements:
+
+  * Added 'multiruby_skip' config so it can be in global ~/.hoerc.
+  * Added Hoe.include_dirs to allow tasks to probe directly.
+  * Added X=exclude_pattern to the test plugin. Can be used in conjunction with N=select_pattern.
+  * Deprecated Hoe::Test.make_test_cmd      (argue with me!)
+  * Deprecated Hoe::Test.try_loading_rspec  (argue with me!)
+  * Deprecated Hoe::Test.try_loading_rspec2 (argue with me!)
+  * Deprecated testunit support             (argue with me!)
+  * Switched normally hoe-generated test tasks over to use Minitest::TestTask.
+
+* 1 bug fix:
+
+  * Fixed incompatibility with rubygems 3.x. (drbrain)
+
 === 3.17.2 / 2019-03-13
 
 * 1 bug fix:

data/Manifest.txt

@@ -24,6 +24,7 @@ lib/hoe/rcov.rb
 lib/hoe/rdoc.rb
 lib/hoe/signing.rb
 lib/hoe/test.rb
+lib/minitest/test_task.rb
 template/.autotest.erb
 template/History.txt.erb
 template/Manifest.txt.erb

data/README.rdoc

@@ -83,7 +83,7 @@ your announcements.
 
 === Manifest.txt
 
-<em><strong>manifest [noun]</strong> a document giving comprehensive
+<em><b>manifest [noun]</b> a document giving comprehensive
 details of a ship and its cargo and other contents, passengers, and
 crew for the use of customs officers.</em>
 
@@ -100,7 +100,7 @@ There is no way in the world that a professionally run ship would ever
 run this way and there is no way that you should either.
 
 Professional software releases know _exactly_ what is in them, amateur
-releases _do not_. "Write better globs" is the response I often hear.
+releases <em>do not</em>. "Write better globs" is the response I often hear.
 I consider myself and the people I work with to be rather smart people
 and if we get them wrong, chances are you will too. How many times
 have you peered under the covers and seen .DS_Store, emacs backup~

data/Rakefile

@@ -7,8 +7,6 @@ Hoe.plugin :seattlerb
 Hoe.plugin :isolate
 Hoe.plugin :rdoc
 
-Hoe.add_include_dirs "../../minitest/dev/lib"
-
 Hoe.spec "hoe" do
   developer "Ryan Davis", "ryand-ruby@zenspider.com"
 

data/lib/hoe.rb

@@ -91,7 +91,7 @@ class Hoe
   include Rake::DSL if defined?(Rake::DSL)
 
   # duh
-  VERSION = "3.17.2"
+  VERSION = "3.18.0"
 
   @@plugins = [:clean, :debug, :deps, :flay, :flog, :newb, :package,
                :publish, :gemcutter, :signing, :test]
@@ -275,11 +275,22 @@ class Hoe
 
   attr_accessor :version
 
+  @include_dirs = []
+
+  mc = (class << self; self; end)
+
+  ##
+  # Optional: Extra directories to use (eg for test runs). See
+  # +Hoe.add_include_dirs+.
+
+  mc.send :attr_accessor, :include_dirs
+
   ##
   # Add extra dirs to both $: and RUBY_FLAGS (for test runs and rakefile deps)
 
   def self.add_include_dirs(*dirs)
     dirs = dirs.flatten
+    include_dirs.concat dirs
     $:.unshift(*dirs)
     s = File::PATH_SEPARATOR
     RUBY_FLAGS.sub!(/-I/, "-I#{dirs.join(s)}#{s}")

data/lib/hoe/package.rb

@@ -97,7 +97,7 @@ module Hoe::Package
     version = "--version '#{version}'" if     version
 
     cmd  = "#{sudo}#{gem_cmd} install #{local} #{name} #{version}"
-    cmd += " --no-rdoc --no-ri" unless rdoc
+    cmd += " --no-document" unless rdoc
     cmd += " #{null_dev}" unless Rake.application.options.trace
 
     puts cmd if Rake.application.options.trace

data/lib/hoe/test.rb

@@ -10,6 +10,12 @@
 # test_deps::          Show which test files fail when run alone.
 
 module Hoe::Test
+  def deprecate msg # :nodoc:
+    where = caller_locations[1]
+
+    warn "DEPRECATED: %s from %s" % [msg, where]
+  end
+
   ##
   # Configuration for the supported test frameworks for test task.
 
@@ -26,15 +32,21 @@ module Hoe::Test
 
   FILTER = (ENV["FILTER"] || ENV["TESTOPTS"] || "").dup
   FILTER << " -n #{ENV["N"]}" if ENV["N"]
+  FILTER << " -e #{ENV["X"]}" if ENV["X"]
 
   # this is an unfortunate naming collision. I don't use the CPU (N)
   # specifier so it is shifting to "C" inside of Hoe.
   ENV.delete "N" if ENV["N"]
   ENV["N"] = ENV["C"] if ENV["C"]
 
+  Hoe::DEFAULT_CONFIG["multiruby_skip"] = []
+
   ##
   # Optional: Array of incompatible versions for multiruby filtering.
   # Used as a regex.
+  #
+  # Can be defined both in .hoerc and in your hoe spec. Both will be
+  # used.
 
   attr_accessor :multiruby_skip
 
@@ -78,41 +90,59 @@ module Hoe::Test
     task :test
 
     if File.directory? "test" then
-      desc "Run the test suite. Use FILTER or TESTOPTS to add flags/args."
-      task :test do
-        ruby make_test_cmd
-      end
+      case testlib
+      when :minitest then
+        require "minitest/test_task" # currently in hoe, but will move
 
-      desc "Print out the test command. Good for profiling and other tools."
-      task :test_cmd do
-        puts make_test_cmd
-      end
+        Minitest::TestTask.create :test do |t|
+          t.test_prelude = self.test_prelude
+          t.libs += Hoe.include_dirs.uniq
+        end
+      when :testunit then
+        desc "Run the test suite. Use FILTER or TESTOPTS to add flags/args."
+        task :test do
+          ruby make_test_cmd
+        end
 
-      desc "Run the test suite using multiruby."
-      task :multi do
-        ENV["EXCLUDED_VERSIONS"] = multiruby_skip.join(":")
-        system "multiruby -S rake"
-      end
+        desc "Print out the test command. Good for profiling and other tools."
+        task :test_cmd do
+          puts make_test_cmd
+        end
+
+        desc "Show which test files fail when run alone."
+        task :test_deps do
+          tests = Dir[*self.test_globs].uniq
 
-      desc "Show which test files fail when run alone."
-      task :test_deps do
-        tests = Dir[*self.test_globs].uniq
+          paths = %w[bin lib test].join(File::PATH_SEPARATOR)
+          null_dev = Hoe::WINDOZE ? "> NUL 2>&1" : "> /dev/null 2>&1"
 
-        paths = %w[bin lib test].join(File::PATH_SEPARATOR)
-        null_dev = Hoe::WINDOZE ? "> NUL 2>&1" : "> /dev/null 2>&1"
+          tests.each do |test|
+            unless system "ruby -I#{paths} #{test} #{null_dev}" then
+              puts "Dependency Issues: #{test}"
+            end
+          end
+        end
 
-        tests.each do |test|
-          unless system "ruby -I#{paths} #{test} #{null_dev}" then
-            puts "Dependency Issues: #{test}"
+        if testlib == :minitest then
+          desc "Show bottom 25 tests wrt time."
+          task "test:slow" do
+            sh "rake TESTOPTS=-v | sort -n -k2 -t= | tail -25"
           end
         end
+      when :none then
+        # do nothing
+      else
+        warn "Unsupported? Moving to Minitest::TestTask. Let me know if you use this!"
       end
 
-      if testlib == :minitest then
-        desc "Show bottom 25 tests wrt time."
-        task "test:slow" do
-          sh "rake TESTOPTS=-v | sort -n -k2 -t= | tail -25"
+      desc "Run the test suite using multiruby."
+      task :multi do
+        skip = with_config do |config, _|
+          config["multiruby_skip"] + self.multiruby_skip
         end
+
+        ENV["EXCLUDED_VERSIONS"] = skip.join(":")
+        system "multiruby -S rake"
       end
 
       default_tasks << :test
@@ -146,6 +176,8 @@ module Hoe::Test
       raise "unsupported test framework #{testlib}"
     end
 
+    deprecate "Moving to Minitest::TestTask. Let me know if you use this!"
+
     framework = SUPPORTED_TEST_FRAMEWORKS[testlib]
 
     tests = ["rubygems"]
@@ -163,6 +195,8 @@ module Hoe::Test
   # Attempt to load RSpec 2, returning true if successful
 
   def try_loading_rspec2
+    deprecate "I want to drop this entirely. Let me know if you use this!"
+
     require "rspec/core/rake_task"
 
     desc "Run all specifications"
@@ -182,6 +216,8 @@ module Hoe::Test
   # Attempt to load RSpec 1, returning true if successful
 
   def try_loading_rspec1
+    deprecate "I want to drop this entirely. Let me know if you use this!"
+
     require "spec/rake/spectask"
 
     desc "Run all specifications"
@@ -194,5 +230,4 @@ module Hoe::Test
     warn "%p while trying to load RSpec 1: %s" % [ err.class, err.message ]
     false
   end
-
 end

data/lib/minitest/test_task.rb

@@ -0,0 +1,217 @@
+require "shellwords"
+require "rbconfig"
+require "rake/tasklib"
+
+module Minitest # :nodoc:
+
+  ##
+  # Minitest::TestTask is a rake helper that generates several rake
+  # tasks under the main test task's name-space.
+  #
+  #   task <name>      :: the main test task
+  #   task <name>:cmd  :: prints the command to use
+  #   task <name>:deps :: runs each test file by itself to find dependency errors
+  #   task <name>:slow :: runs the tests and reports the slowest 25 tests.
+  #
+  # Examples:
+  #
+  #   Minitest::TestTask.create
+  #
+  # The most basic and default setup.
+  #
+  #   Minitest::TestTask.create :do_the_thing
+  #
+  # The most basic/default setup, but with a custom name
+  #
+  #   Minitest::TestTask.create :spec do |t|
+  #     t.test_globs = ["spec/**/*_spec.rb"]
+  #     t.libs << "../dependency/lib"
+  #   end
+  #
+  # Customize the name, dependencies, and use a spec directory instead
+  # of test.
+
+  class TestTask < Rake::TaskLib
+    WINDOWS = RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ # :nodoc: # TODO: verify
+
+    ##
+    # Create several test-oriented tasks under +name+. Takes an
+    # optional block to customize variables.
+
+    def self.create name = :test, &block
+      task = new name
+      task.instance_eval(&block) if block
+      task.process_env
+      task.define
+      task
+    end
+
+    ##
+    # Extra arguments to pass to the tests. Defaults empty but gets
+    # populated by a number of enviroment variables:
+    #
+    # + N (-n flag) a string or regexp of tests to run.
+    # + X (-e flag) a string or regexp of tests to exclude.
+    # + TESTOPTS - extra stuff. For compatibility? I guess?
+    # + A (arg) - quick way to inject an arbitrary argument (eg A=--help)
+
+    attr_accessor :extra_args
+
+    ##
+    # The code to load the framework. Defaults to requiring
+    # minitest/autorun...
+    #
+    # Why do I have this as an option?
+
+    attr_accessor :framework
+
+    ##
+    # Extra library directories to include. Defaults to %w[lib test
+    # .]. Also uses $MT_LIB_EXTRAS allowing you to dynamically
+    # override/inject directories for custom runs.
+
+    attr_accessor :libs
+
+    ##
+    # The name of the task and base name for the other tasks generated.
+
+    attr_accessor :name
+
+    ##
+    # File globs to find test files. Defaults to something sensible to
+    # find test files under the test directory.
+
+    attr_accessor :test_globs
+
+    ##
+    # Turn on ruby warnings (-w flag). Defaults to true.
+
+    attr_accessor :warning
+
+    ##
+    # Optional: Additional ruby to run before the test framework is loaded.
+
+    attr_accessor :test_prelude
+
+    ##
+    # Print out commands as they run. Defaults to Rake's trace (-t
+    # flag) option.
+
+    attr_accessor :verbose
+
+    def initialize name = :test # :nodoc:
+      self.extra_args   = []
+      self.framework    = %(require "minitest/autorun")
+      self.libs         = %w[lib test .]
+      self.name         = name
+      self.test_globs   = ["test/**/{test,spec}_*.rb",
+                           "test/**/*_{test,spec}.rb"]
+      self.test_prelude = nil
+      self.verbose      = Rake.application.options.trace
+      self.warning      = true
+    end
+
+    ##
+    # Extract variables from the environment and convert them to
+    # command line arguments. See +extra_args+.
+    #
+    # Environment Variables:
+    #
+    # + MT_LIB_EXTRAS - Extra libs to dynamically override/inject for custom runs.
+    # + N             - Tests to run (string or regexp)
+    # + X             - Tests to exclude (string or regexp)
+    # + TESTOPTS      - deprecated, use A
+    # + A             - Any extra arguments. Honors shell quoting.
+
+    def process_env
+      warn "TESTOPTS is deprecated in Minitest::TestTask. Use A instead" if
+        ENV["TESTOPTS"]
+
+      lib_extras = (ENV["MT_LIB_EXTRAS"] || "").split File::PATH_SEPARATOR
+      self.libs.prepend lib_extras
+
+      extra_args << "-n" << ENV["N"]                      if ENV["N"]
+      extra_args << "-e" << ENV["X"]                      if ENV["X"]
+      extra_args.concat Shellwords.split(ENV["TESTOPTS"]) if ENV["TESTOPTS"]
+      extra_args.concat Shellwords.split(ENV["A"])        if ENV["A"]
+
+      # TODO? RUBY_DEBUG = ENV["RUBY_DEBUG"]
+      # TODO? ENV["RUBY_FLAGS"]
+
+      extra_args.compact!
+    end
+
+    ##
+    # Create the tasks.
+
+    def define
+      default_tasks = []
+
+      desc "Run the test suite. Use N, X, A, and TESTOPTS to add flags/args."
+      task name do
+        ruby make_test_cmd, verbose:verbose
+      end
+
+      desc "Print out the test command. Good for profiling and other tools."
+      task "#{name}:cmd" do
+        puts "ruby #{make_test_cmd}"
+      end
+
+      desc "Show which test files fail when run alone."
+      task "#{name}:deps" do
+        tests = Dir[*self.test_globs].uniq
+
+        null_dev = WINDOWS ? "> NUL 2>&1" : "> /dev/null 2>&1"
+
+        tests.each do |test|
+          cmd = make_test_cmd test
+
+          if system "ruby #{cmd} #{null_dev}" then
+            puts "# good: #{test}"
+          else
+            puts "# bad: #{test}"
+            puts "  ruby #{cmd}"
+          end
+        end
+      end
+
+      desc "Show bottom 25 tests wrt time."
+      task "#{name}:slow" do
+        sh ["rake #{name} TESTOPTS=-v",
+            "egrep '#test_.* s = .'",
+            "sort -n -k2 -t=",
+            "tail -25"].join " | "
+      end
+
+      default_tasks << name
+
+      desc "Run the default task(s)."
+      task :default => default_tasks
+    end
+
+    ##
+    # Generate the test command-line.
+
+    def make_test_cmd globs = test_globs
+      tests = []
+      tests.concat Dir[*globs].shuffle
+      tests.map! { |f| %(require "#{f}") }
+
+      runner = []
+      runner << framework
+      runner << test_prelude if test_prelude
+      runner.concat tests
+      runner = runner.join "; "
+
+      args  = []
+      args << "-I#{libs.join(File::PATH_SEPARATOR)}" unless libs.empty?
+      args << "-w" if warning
+      args << '-e'
+      args << "'#{runner}'"
+      args << '--'
+      args << extra_args.map(&:shellescape)
+
+      args.join " "
+    end
+  end
+end

data/test/test_hoe_package.rb

@@ -1,3 +1,5 @@
+require "hoe"
+
 Hoe.load_plugins
 
 class TestHoePackage < Minitest::Test

data/test/test_hoe_test.rb

@@ -18,6 +18,14 @@ class TestHoeTest < Minitest::Test
     end
   end
 
+  def assert_deprecated
+    err_re = /DEPRECATED:/
+
+    assert_output "", err_re do
+      yield
+    end
+  end
+
   def test_make_test_cmd_with_different_testlibs
     skip "Using TESTOPTS... skipping" if ENV["TESTOPTS"]
 
@@ -27,19 +35,27 @@ class TestHoeTest < Minitest::Test
                ].join
 
     # default
-    autorun = %(require "minitest/autorun"; )
-    assert_equal expected % autorun, @tester.make_test_cmd
+    assert_deprecated do
+      autorun = %(require "minitest/autorun"; )
+      assert_equal expected % autorun, @tester.make_test_cmd
+    end
 
-    @tester.testlib = :testunit
-    testunit = %(require "test/unit"; )
-    assert_equal expected % testunit, @tester.make_test_cmd
+    assert_deprecated do
+      @tester.testlib = :testunit
+      testunit = %(require "test/unit"; )
+      assert_equal expected % testunit, @tester.make_test_cmd
+    end
 
-    @tester.testlib = :minitest
-    autorun = %(require "minitest/autorun"; )
-    assert_equal expected % autorun, @tester.make_test_cmd
+    assert_deprecated do
+      @tester.testlib = :minitest
+      autorun = %(require "minitest/autorun"; )
+      assert_equal expected % autorun, @tester.make_test_cmd
+    end
 
-    @tester.testlib = :none
-    assert_equal expected % "", @tester.make_test_cmd
+    assert_deprecated do
+      @tester.testlib = :none
+      assert_equal expected % "", @tester.make_test_cmd
+    end
 
     @tester.testlib = :faketestlib
     e = assert_raises(RuntimeError) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hoe
 version: !ruby/object:Gem::Version
-  version: 3.17.2
+  version: 3.18.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -29,7 +29,7 @@ cert_chain:
   Em82dBUFsipwMLCYj39kcyHWAxyl6Ae1Cn9r/ItVBCxoeFdrHjfavnrIEoXUt4bU
   UfBugfLD19bu3nvL+zTAGx/U
   -----END CERTIFICATE-----
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -118,6 +118,7 @@ files:
 - lib/hoe/rdoc.rb
 - lib/hoe/signing.rb
 - lib/hoe/test.rb
+- lib/minitest/test_task.rb
 - template/.autotest.erb
 - template/History.txt.erb
 - template/Manifest.txt.erb
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '1.4'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Hoe is a rake/rubygems helper for project Rakefiles

metadata.gz.sig

@@ -1 +1 @@
-��v"z���I�#p'��l�\v9�䤈��r��M�n���7*$��l?������5M�`��2h�̊�`ܝ��0�����}�. 66�D��<2�f���b�$���,if�-\+r%Y��{���?��_I�i��V
	�<�.jƵ9R�/��(��'�
��g�����U?�Z���̞�98�\��y�L�g�x�l!�7㈂GsP��Ǐ+���
+��g�S~�a�y�鑁ܒQ�J����>�h���?Bg��Գ����44�mGb�Ւis