pluggability 0.4.3 → 0.8.0

data/spec/pluggability_spec.rb

@@ -17,6 +17,7 @@ end
 class SubPlugin < Plugin; end
 class TestingPlugin < Plugin; end
 class BlackSheep < Plugin; end
+class Carbon14Robot < Plugin; end
 module Test
 	class LoadablePlugin < Plugin; end
 end
@@ -29,16 +30,9 @@ class SubSubPlugin < SubPlugin; end
 #
 describe Pluggability do
 
-	before( :all ) do
-		setup_logging()
-	end
-
 	before( :each ) do
 		Plugin.plugin_exclusions = []
-	end
-
-	after( :all ) do
-		reset_logging()
+		allow( File ).to receive( :file? ).and_return( true )
 	end
 
 
@@ -47,7 +41,6 @@ describe Pluggability do
 	end
 
 
-
 	context "-extended class" do
 
 		it "knows about all of its derivatives" do
@@ -55,6 +48,7 @@ describe Pluggability do
 				to include( 'sub', 'subplugin', 'SubPlugin', SubPlugin )
 		end
 
+
 		it "returns derivatives directly if they're already loaded" do
 			class AlreadyLoadedPlugin < Plugin; end
 			expect( Kernel ).to_not receive( :require )
@@ -64,6 +58,7 @@ describe Pluggability do
 			expect( Plugin.create(AlreadyLoadedPlugin) ).to be_an_instance_of( AlreadyLoadedPlugin )
 		end
 
+
 		it "filters errors that happen when creating an instance of derivatives so they " +
 			"point to the right place" do
 			class PugilistPlugin < Plugin
@@ -84,6 +79,7 @@ describe Pluggability do
 			expect( exception.backtrace.first ).to match(/#{__FILE__}/)
 		end
 
+
 		it "will refuse to create an object other than one of its derivatives" do
 			class Doppelgaenger; end
 			expect {
@@ -95,7 +91,10 @@ describe Pluggability do
 		it "will load new plugins from the require path if they're not loaded yet" do
 			loaded_class = nil
 
-			expect( Plugin ).to receive( :require ).with( 'plugins/dazzle_plugin' ) do |*args|
+			expect( Gem ).to receive( :find_latest_files ).
+				at_least( :once ).
+				and_return( ['/some/path/to/plugins/dazzle.rb'] )
+			expect( Kernel ).to receive( :require ).with( '/some/path/to/plugins/dazzle.rb' ) do |*args|
 				loaded_class = Class.new( Plugin )
 				# Simulate a named class, since we're not really requiring
 				Plugin.derivatives['dazzle'] = loaded_class
@@ -110,8 +109,8 @@ describe Pluggability do
 			"derivative fails" do
 
 			# at least 6 -> 3 variants * 2 paths
-			expect( Plugin ).to receive( :require ).at_least(6).times.
-				and_raise( LoadError.new("path") )
+			expect( Gem ).to receive( :find_latest_files ).at_least( 6 ).times.
+				and_return( [] )
 
 			expect {
 				Plugin.create('scintillating')
@@ -120,8 +119,12 @@ describe Pluggability do
 
 
 		it "will output a sensible description when a require succeeds, but it loads something unintended" do
-			# at least 6 -> 3 variants * 2 paths
-			expect( Plugin ).to receive( :require ).and_return( true )
+			expect( Gem ).to receive( :find_latest_files ).
+				at_least( :once ).
+				and_return( ['/some/path/to/corruscating.rb'] )
+			expect( Kernel ).to receive( :require ).
+				with( '/some/path/to/corruscating.rb' ).
+				and_return( true )
 
 			expect {
 				Plugin.create('corruscating')
@@ -129,30 +132,48 @@ describe Pluggability do
 		end
 
 
-		it "will re-raise the first exception raised when attempting to load a " +
-			"derivative if none of the paths work" do
-
-			# at least 6 -> 3 variants * 2 paths
-			expect( Plugin ).to receive( :require ).at_least(6).times.
+		it "doesn't rescue LoadErrors raised when loading the plugin" do
+			expect( Gem ).to receive( :find_latest_files ).
+				at_least( :once ).
+				and_return( ['/some/path/to/portable.rb'] )
+			expect( Kernel ).to receive( :require ).
+				with( '/some/path/to/portable.rb' ).
 				and_raise( ScriptError.new("error while parsing path") )
 
 			expect {
-				Plugin.create('portable')
+				Plugin.create( 'portable' )
 			}.to raise_error( ScriptError, /error while parsing/ )
 		end
 
 
+		it "ignores directories when finding derivatives" do
+			expect( Gem ).to receive( :find_latest_files ).
+				at_least( :once ).
+				and_return( ['/some/path/to/portable', '/some/path/to/portable.rb'] )
+			expect( File ).to receive( :file? ).and_return( false )
+
+			expect( Kernel ).to_not receive( :require ).with( '/some/path/to/portable' )
+			expect( Kernel ).to receive( :require ).
+				with( '/some/path/to/portable.rb' ).
+				and_return( true )
+
+			expect {
+				Plugin.create( 'portable' )
+			}.to raise_error( Pluggability::PluginError, /Require of '\S+' succeeded, but didn't load a Plugin/i )
+		end
+
+
 		it "can preload all of its derivatives" do
 			expect( Gem ).to receive( :find_latest_files ).with( 'plugins/*.rb' ).
 				and_return([ 'plugins/first.rb' ])
 			expect( Gem ).to receive( :find_latest_files ).with( 'plugins/private/*.rb' ).
 				and_return([ 'plugins/private/second.rb', 'plugins/private/third.rb' ])
 
-			expect( Plugin ).to receive( :require ).with( 'plugins/first.rb' ).
+			expect( Kernel ).to receive( :require ).with( 'plugins/first.rb' ).
 				and_return( true )
-			expect( Plugin ).to receive( :require ).with( 'plugins/private/second.rb' ).
+			expect( Kernel ).to receive( :require ).with( 'plugins/private/second.rb' ).
 				and_return( true )
-			expect( Plugin ).to receive( :require ).with( 'plugins/private/third.rb' ).
+			expect( Kernel ).to receive( :require ).with( 'plugins/private/third.rb' ).
 				and_return( true )
 
 			Plugin.load_all
@@ -161,14 +182,14 @@ describe Pluggability do
 
 		it "doesn't preload derivatives whose path matches a Regexp exclusion" do
 			expect( Gem ).to receive( :find_latest_files ).with( 'plugins/*.rb' ).
-				and_return([ 'plugins/first.rb' ])
+				and_return([ '/path/to/plugins/first.rb' ])
 			expect( Gem ).to receive( :find_latest_files ).with( 'plugins/private/*.rb' ).
-				and_return([ 'plugins/private/second.rb', 'plugins/private/third.rb' ])
+				and_return([ '/path/to/plugins/private/second.rb', '/path/to/plugins/private/third.rb' ])
 
-			expect( Plugin ).to receive( :require ).with( 'plugins/first.rb' ).
+			expect( Kernel ).to receive( :require ).with( '/path/to/plugins/first.rb' ).
 				and_return( true )
-			expect( Plugin ).to_not receive( :require ).with( 'plugins/private/second.rb' )
-			expect( Plugin ).to_not receive( :require ).with( 'plugins/private/third.rb' )
+			expect( Kernel ).to_not receive( :require ).with( '/path/to/plugins/private/second.rb' )
+			expect( Kernel ).to_not receive( :require ).with( '/path/to/plugins/private/third.rb' )
 
 			Plugin.plugin_exclusions( %r{/private} )
 			Plugin.load_all
@@ -181,11 +202,11 @@ describe Pluggability do
 			expect( Gem ).to receive( :find_latest_files ).with( 'plugins/private/*.rb' ).
 				and_return([ 'plugins/private/second.rb', 'plugins/private/third.rb' ])
 
-			expect( Plugin ).to receive( :require ).with( 'plugins/first.rb' ).
+			expect( Kernel ).to receive( :require ).with( 'plugins/first.rb' ).
 				and_return( true )
-			expect( Plugin ).to receive( :require ).with( 'plugins/private/second.rb' ).
+			expect( Kernel ).to receive( :require ).with( 'plugins/private/second.rb' ).
 				and_return( true )
-			expect( Plugin ).to_not receive( :require ).with( 'plugins/private/third.rb' )
+			expect( Kernel ).to_not receive( :require ).with( 'plugins/private/third.rb' )
 
 			Plugin.plugin_exclusions( '**/third.rb' )
 			Plugin.load_all
@@ -200,6 +221,7 @@ describe Pluggability do
 			expect( TestingPlugin.plugin_type ).to eq( 'Plugin' )
 		end
 
+
 		it "raises a PluginError if it can't figure out what type of factory loads it" do
 			allow( TestingPlugin ).to receive( :ancestors ).and_return( [] )
 			expect {
@@ -207,6 +229,7 @@ describe Pluggability do
 			}.to raise_error( Pluggability::PluginError, /couldn't find plugin base/i )
 		end
 
+
 		it "knows what the simplest version of its plugin name is" do
 			expect( TestingPlugin.plugin_name ).to eq( 'testing' )
 		end
@@ -219,10 +242,17 @@ describe Pluggability do
 			expect( Plugin.create('blacksheep') ).to be_an_instance_of( BlackSheep )
 		end
 
+
 		it "is loadable via its underbarred name" do
 			expect( Plugin.create('black_sheep') ).to be_an_instance_of( BlackSheep )
 		end
 
+
+		it "works for classes with numbers in them too" do
+			expect( Plugin.create('carbon14_robot') ).to be_an_instance_of( Carbon14Robot )
+		end
+
+
 		it "knows what the simplest version of its plugin name is" do
 			expect( BlackSheep.plugin_name ).to eq( 'black_sheep' )
 		end
@@ -235,9 +265,11 @@ describe Pluggability do
 			expect( Plugin.create('loadable') ).to be_an_instance_of( Test::LoadablePlugin )
 		end
 
+
 		it "still knows what the simplest version of its plugin name is" do
 			expect( Test::LoadablePlugin.plugin_name ).to eq( 'loadable' )
 		end
+
 	end
 
 
@@ -247,9 +279,11 @@ describe Pluggability do
 			expect( Plugin.derivatives['subsub'] ).to eq( SubSubPlugin )
 		end
 
+
 		it "still knows what the simplest version of its plugin name is" do
 			expect( SubSubPlugin.plugin_name ).to eq( 'subsub' )
 		end
+
 	end
 
 end

metadata

@@ -1,37 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: pluggability
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.8.0
 platform: ruby
 authors:
-- Martin Chase
 - Michael Granger
-autorequire: 
+- Martin Chase
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQwwCgYDVQQDDANnZWQx
-  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
-  HhcNMTQwMzE5MDQzNTI2WhcNMTUwMzE5MDQzNTI2WjA+MQwwCgYDVQQDDANnZWQx
-  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
-  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDb92mkyYwuGBg1oRxt2tkH
-  +Uo3LAsaL/APBfSLzy8o3+B3AUHKCjMUaVeBoZdWtMHB75X3VQlvXfZMyBxj59Vo
-  cDthr3zdao4HnyrzAIQf7BO5Y8KBwVD+yyXCD/N65TTwqsQnO3ie7U5/9ut1rnNr
-  OkOzAscMwkfQxBkXDzjvAWa6UF4c5c9kR/T79iA21kDx9+bUMentU59aCJtUcbxa
-  7kcKJhPEYsk4OdxR9q2dphNMFDQsIdRO8rywX5FRHvcb+qnXC17RvxLHtOjysPtp
-  EWsYoZMxyCDJpUqbwoeiM+tAHoz2ABMv3Ahie3Qeb6+MZNAtMmaWfBx3dg2u+/WN
-  AgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBSZ0hCV
-  qoHr122fGKelqffzEQBhszAcBgNVHREEFTATgRFnZWRARmFlcmllTVVELm9yZzAc
-  BgNVHRIEFTATgRFnZWRARmFlcmllTVVELm9yZzANBgkqhkiG9w0BAQUFAAOCAQEA
-  TuL1Bzl6TBs1YEzEubFHb9XAPgehWzzUudjDKzTRd+uyZmxnomBqTCQjT5ucNRph
-  3jZ6bhLNooLQxTjIuHodeGcEMHZdt4Yi7SyPmw5Nry12z6wrDp+5aGps3HsE5WsQ
-  Zq2EuyEOc96g31uoIvjNdieKs+1kE+K+dJDjtw+wTH2i63P7r6N/NfPPXpxsFquo
-  wcYRRrHdR7GhdJeT+V8Q8Bi5bglCUGdx+8scMgkkePc98k9osQHypbACmzO+Bqkv
-  c7ZKPJcWBv0sm81+FCZXNACn2f9jfF8OQinxVs0O052KbGuEQaaiGIYeuuwQE2q6
-  ggcrPfcYeTwWlfZPu2LrBg==
+  MIID+DCCAmCgAwIBAgIBBDANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
+  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMjAxMDcyMzU4MTRaFw0yMzAxMDcyMzU4
+  MTRaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
+  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
+  L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
+  M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
+  5PU2AEbf04GGSrmqADGWXeaslaoRdb1fu/0M5qfPTRn5V39sWD9umuDAF9qqil/x
+  Sl6phTvgBrG8GExHbNZpLARd3xrBYLEFsX7RvBn2UPfgsrtvpdXjsHGfpT3IPN+B
+  vQ66lts4alKC69TE5cuKasWBm+16A4aEe3XdZBRNmtOu/g81gvwA7fkJHKllJuaI
+  dXzdHqq+zbGZVSQ7pRYHYomD0IiDe1DbIouFnPWmagaBnGHwXkDT2bKKP+s2v21m
+  ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
+  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYD
+  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DANBgkqhkiG
+  9w0BAQsFAAOCAYEASrm1AbEoxACZ9WXJH3R5axV3U0CA4xaETlL2YT+2nOfVBMQ9
+  0ZlkPx6j4ghKJgAIi1TMfDM2JyPJsppQh8tiNccDjWc62UZRY/dq26cMqf/lcI+a
+  6YBuEYvzZfearwVs8tHnXtwYV3WSCoCOQaB+nq2lA1O+nkKNl41WOsVbNama5jx3
+  8cQtVSEEmZy6jIDJ8c5TmBJ7BQUDEUEWA/A3V42Xyctoj7DvUXWE0lP+X6ypAVSr
+  lFh3TS64D7NTvxkmg7natUoCvobl6kGl4yMaqE4YRTlfuzhpf91TSOntClqrAOsS
+  K1s56WndQj3IoBocdY9mQhDZLtLHofSkymoP8btBlj5SsN24TiF0VMSZlctSCYZg
+  GKyHim/MMlIfGOWsgfioq5jzwmql7W4CDubbb8Lkg70v+hN2E/MnNVAcNE3gyaGc
+  P5YP5BAbNW+gvd3QHRiWTTuhgHrdDnGdXg93N2M5KHn1ug8BtPLQwlcFwEpKnlLn
+  btEP+7EplFuoiMfd
   -----END CERTIFICATE-----
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -39,44 +42,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: hoe-mercurial
+  name: rake-deveiate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: hoe-deveiate
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: hoe-highline
+  name: rdoc-generator-sixfish
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -89,96 +78,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: hoe-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: hoe
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.13'
-description: "Pluggability is a mixin module that turns an including class into a\nfactory
-  for its derivatives, capable of searching for and loading them\nby name. This is
-  useful when you have an abstract base class which\ndefines an interface and basic
-  functionality for a part of a larger\nsystem, and a collection of subclasses which
-  implement the interface for\ndifferent underlying functionality.\n\nAn example of
-  where this might be useful is in a program which generates\noutput with a 'driver'
-  object, which provides a unified interface but\ngenerates different kinds of output.\n\nFirst
-  the abstract base class, which is extended with Pluggability:\n\n    # in mygem/driver.rb:\n
-  \   require 'pluggability'\n    require 'mygem' unless defined?( MyGem )\n    \n
-  \   class MyGem::Driver\n        extend Pluggability\n        plugin_prefixes \"drivers\",
-  \"drivers/compat\"\n    end\n\nWe can have one driver that outputs PDF documents:\n\n
-  \   # mygem/drivers/pdf.rb:\n    require 'mygem/driver' unless defined?( MyGem::Driver
-  )\n    \n    class MyGem::Driver::PDF < Driver\n        ...implementation...\n    end\n\nand
-  another that outputs plain ascii text:\n\n    #mygem/drivers/ascii.rb:\n    require
-  'mygem/driver' unless defined?( MyGem::Driver )\n    \n    class MyGem::Driver::ASCII
-  < Driver\n        ...implementation...\n    end\n\nNow the driver is configurable
-  by the end-user, who can just set\nit by its short name:\n\n    require 'mygem'\n
-  \   \n    config[:driver_type] #=> \"pdf\"\n    driver = MyGem::Driver.create( config[:driver_type]
-  )\n    driver.class #=> MyGem::Driver::PDF\n\n    # You can also pass arguments
-  to the constructor, too:\n    ascii_driver = MyGem::Driver.create( :ascii, :columns
-  => 80 )"
+description: Pluggability is a toolkit for creating plugins.
 email:
-- stillflame@FaerieMUD.org
-- ged@FaerieMUD.org
+- ged@faeriemud.org
+- outofculture@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- History.rdoc
-- Manifest.txt
-- README.rdoc
+extra_rdoc_files: []
 files:
-- ".gemtest"
-- ChangeLog
-- History.rdoc
-- Manifest.txt
-- README.rdoc
-- Rakefile
+- History.md
+- README.md
 - lib/pluggability.rb
 - spec/helpers.rb
 - spec/pluggability_spec.rb
-homepage: https://bitbucket.org/ged/pluggability
+homepage: https://hg.sr.ht/~ged/Pluggability
 licenses:
-- BSD
-metadata: {}
-post_install_message: 
-rdoc_options:
-- "-t"
-- Pluggability Toolkit
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://hg.sr.ht/~ged/Pluggability
+  documentation_uri: https://deveiate.org/code/pluggability
+  changelog_uri: https://deveiate.org/code/pluggability/History_md.html
+  source_uri: https://hg.sr.ht/~ged/Pluggability/browse
+  bug_tracker_uri: https://todo.sr.ht/~ged/Pluggability/browse
+post_install_message:
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -192,10 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Pluggability is a mixin module that turns an including class into a factory
-  for its derivatives, capable of searching for and loading them by name
+summary: Pluggability is a toolkit for creating plugins.
 test_files: []