pluggability 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 843f2f58748eaeb19465a3e12811c495c218b84bfd0561dd7266b1aa039c2088
-  data.tar.gz: 376ce248e38a0547faaff01bfc033baf099e3cc33431387f56c2f5f789e896cf
+  metadata.gz: acdddb8e543aa6046ffbdbd68d67588eed0cb3ba2ab70bf2f2c1ea8fb5e55e86
+  data.tar.gz: 06e1b5426c52c27250e940a401327a6176ce666d22b7cba988746c85de96cb95
 SHA512:
-  metadata.gz: 26b4d2466c36294eb1d336c88ff1a61b6c73283626d21766d3929b9ce86babc8144889c7f27adf2fd6b44b5177c2988b4c7f4b60ce9b66e9ad8825d2dc40f6c6
-  data.tar.gz: d99e802e78109839a9e8df5ff75d9493323a4fb72328f62c63d841cdf5199d73ba3aac0bd46f161db1c83cb7f70ef4c74c28485b7ecb9ff97c9bc2d83d9ba96d
+  metadata.gz: f84aae2fa72d6425a69592bb4ea1fcc37e6e5dc96d9b03ab1f6c5d2954f86806f4316dd4e9baf0cb7111ffb1f9b2d682c43b44305750f84a66afb8faaf738368
+  data.tar.gz: 01bc40509082e86090d3770491e15473b0fdf5cabbb3021ec8bfdf4a9e56b73f579e43cfcebf5909454da4ec1802bae201ad68ea2107281ae7a15bc24e9bfaed

data/History.md

@@ -2,6 +2,14 @@
 
 ---
 
+## v0.10.0 [2025-07-12] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Remove support for non-Ruby idiomatic plugin paths
+- Add support for newer Ruby features, e.g., Module#set_temporary_name.
+
+
 ## v0.9.0 [2023-06-08] Michael Granger <ged@faeriemud.org>
 
 Improvements:

data/lib/pluggability.rb

@@ -1,8 +1,8 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'loggability' unless defined?( Loggability )
 
+
 # The Pluggability module
 module Pluggability
 	extend Loggability
@@ -12,7 +12,7 @@ module Pluggability
 
 
 	# Library version
-	VERSION = '0.9.0'
+	VERSION = '0.10.0'
 
 
 	# An exception class for Pluggability specific errors.
@@ -20,12 +20,26 @@ module Pluggability
 	FactoryError = PluginError
 
 
+	module StringRefinements
+		refine( String ) do
+
+			def uncamelcase
+				return self.gsub( /([a-z0-9])([A-Z])/, "\\1_\\2" )
+			end
+
+		end
+	end
+	using StringRefinements
+
+
 	### Add the @derivatives instance variable to including classes.
 	def self::extend_object( obj )
 		obj.instance_variable_set( :@plugin_prefixes, [] )
 		obj.instance_variable_set( :@plugin_exclusions, [] )
 		obj.instance_variable_set( :@derivatives, {} )
 
+		obj.singleton_class.attr_accessor( :plugin_name )
+
 		Pluggability.pluggable_classes << obj
 
 		super
@@ -125,15 +139,30 @@ module Pluggability
 			return base.name
 		end
 	end
-	alias factory_type plugin_type
+	alias_method :factory_type, :plugin_type
 
 
 	### Inheritance callback -- Register subclasses in the derivatives hash
 	### so that ::create knows about them.
 	def inherited( subclass )
-		plugin_class = Pluggability.plugin_base_class( subclass )
+		Pluggability.log.debug "  %p inherited by %p" % [ self, subclass ]
+		self.register_plugin_type( subclass )
+		super
+	end
 
-		Pluggability.logger.debug "%p inherited by %p" % [ plugin_class, subclass ]
+
+	### Override Module#set_temporary_name so +new_name+ can be used to derive the
+	### plugin name. Note that this does *not* detect if you later assign the
+	### anonymous class to a constant and thus clear its temporary name.
+	def set_temporary_name( new_name )
+		super
+		self.register_plugin_type( self )
+	end
+
+
+	### Register the given +subclass+ as a plugin type of the receiving Pluggable class.
+	def register_plugin_type( subclass )
+		plugin_class = Pluggability.plugin_base_class( subclass )
 		keys = [ subclass ]
 
 		# If it's not an anonymous class, make some keys out of variants of its name
@@ -153,13 +182,8 @@ module Pluggability
 			plugin_class.derivatives[ key ] = subclass
 		end
 
-		# Add a name attribute to it
-		class << subclass
-			attr_reader :plugin_name
-		end
-		subclass.instance_variable_set( :@plugin_name, keys.last )
-
-		super
+		Pluggability.log.debug "Setting plugin name of %p to %p" % [ subclass, keys.last ]
+		subclass.plugin_name = keys.last
 	end
 
 
@@ -168,19 +192,16 @@ module Pluggability
 	def make_derivative_names( subclass )
 		keys = []
 
-		simple_name = subclass.name.sub( /^.*::/i, '' ).sub( /\W+$/, '' )
+		# Order is important here, as the last non-nil one becomes the plugin_name.
+		simple_name = subclass.name.sub( /\A.*::/, '' ).sub( /\A(\w+).*/, '\\1' )
 		keys << simple_name << simple_name.downcase
-		keys << simple_name.gsub( /([a-z0-9])([A-Z])/, "\\1_\\2" ).downcase
+		keys << simple_name.uncamelcase.downcase
 
-		# Handle class names like 'FooBar' for 'Bar' factories.
-		Pluggability.log.debug "Inherited %p for %p-type plugins" % [ subclass, self.plugin_type ]
-		if subclass.name.match( /(?:.*::)?(\w+)(?:#{self.plugin_type})/i )
-			keys << Regexp.last_match[1].downcase
-		else
-			keys << subclass.name.sub( /.*::/, '' ).downcase
-		end
+		simpler_name = simple_name.sub( /(?:#{self.plugin_type})\z/, '' )
+		keys << simpler_name << simpler_name.downcase
+		keys << simpler_name.uncamelcase.downcase
 
-		return keys
+		return keys.uniq
 	end
 
 
@@ -361,6 +382,7 @@ module Pluggability
 
 		candidate_paths = candidates.
 			flat_map {|path| Gem.find_latest_files( path ) }.
+			uniq.
 			reject {|path| self.is_excluded_path?( path ) || ! File.file?(path) }
 		Pluggability.log.debug "Valid candidates in the current gemset: %p" % [ candidate_paths ]
 
@@ -374,7 +396,7 @@ module Pluggability
 		prefixes = self.plugin_prefixes
 		prefixes << '' if prefixes.empty?
 
-		return prefixes.flat_map {|pre| self.make_require_path(mod_name, pre) }
+		return prefixes.flat_map {|pre| self.make_require_path(mod_name, pre) }.uniq
 	end
 
 
@@ -385,17 +407,12 @@ module Pluggability
 	###    "drivers/SocketDataDriver", "drivers/socket", "drivers/Socket"]
 	def make_require_path( modname, subdir )
 		path = []
-		myname = self.plugin_type
+		myname = self.plugin_type.uncamelcase.downcase
+		modname = modname.uncamelcase.downcase
 
 		# Make permutations of the two parts
 		path << modname
-		path << modname.downcase
-		path << modname			       + myname
-		path << modname.downcase       + myname
-		path << modname.downcase       + myname.downcase
-		path << modname			 + '_' + myname
-		path << modname.downcase + '_' + myname
-		path << modname.downcase + '_' + myname.downcase
+		path << modname + '_' + myname
 
 		# If a non-empty subdir was given, prepend it to all the items in the
 		# path

data/spec/helpers.rb

@@ -1,19 +1,28 @@
-#!/usr/bin/ruby
-# coding: utf-8
+# -*- ruby -*-
 
 require 'rspec'
+require 'diff/lcs'
 require 'loggability/spechelpers'
 require 'pluggability'
 
-### Mock with Rspec
+# Mock with Rspec
 RSpec.configure do |config|
+	config.mock_with( :rspec ) do |mock|
+		mock.syntax = :expect
+	end
 
-	config.run_all_when_everything_filtered = true
+	config.disable_monkey_patching!
+	config.example_status_persistence_file_path = "spec/.status"
 	config.filter_run :focus
-	config.order = 'random'
-    config.warnings = true
-	config.mock_with( :rspec ) do |mock_config|
-		mock_config.syntax = :expect
+	config.filter_run_when_matching :focus
+	config.order = :random
+	config.profile_examples = 5
+	config.run_all_when_everything_filtered = true
+	config.shared_context_metadata_behavior = :apply_to_host_groups
+	config.warnings = true
+
+	config.expect_with( :rspec ) do |expectations|
+		expectations.include_chain_clauses_in_custom_matcher_descriptions = true
 	end
 
 	config.include( Loggability::SpecHelpers )

data/spec/pluggability_spec.rb

@@ -3,7 +3,7 @@
 require_relative 'helpers'
 
 require 'pluggability'
-
+require 'loggability'
 
 #
 # Testing classes
@@ -34,7 +34,7 @@ class SubSubPlugin < SubPlugin; end
 #
 # Examples
 #
-describe Pluggability do
+RSpec.describe Pluggability do
 
 	before( :each ) do
 		Plugin.plugin_exclusions = []
@@ -101,9 +101,9 @@ describe Pluggability do
 				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
+				loaded_class = Class.new( Plugin ) do
+					set_temporary_name 'Plugin::Dazzle (testing class)'
+				end
 				true
 			end
 
@@ -111,11 +111,31 @@ describe Pluggability do
 		end
 
 
+		it "will load new plugins from the require path if given a camel-cased class name" do
+			loaded_class = nil
+
+			expect( Gem ).to receive( :find_latest_files ).
+				at_least( :once ).
+				and_return( ['/some/path/to/plugins/razzle_dazzle.rb'] )
+			expect( Kernel ).to receive( :require ) do |require_path|
+				expect( require_path ).to eq( '/some/path/to/plugins/razzle_dazzle.rb' )
+
+				loaded_class = Class.new( Plugin ) do
+					set_temporary_name 'Plugin::RazzleDazzle (testing class)'
+				end
+
+				true
+			end
+
+			expect( Plugin.create(:RazzleDazzle) ).to be_an_instance_of( loaded_class )
+		end
+
+
 		it "will output a sensible description of what it tried to load if requiring a " +
 			"derivative fails" do
 
 			# at least 6 -> 3 variants * 2 paths
-			expect( Gem ).to receive( :find_latest_files ).at_least( 6 ).times.
+			expect( Gem ).to receive( :find_latest_files ).at_least( 4 ).times.
 				and_return( [] )
 
 			expect {
@@ -293,7 +313,7 @@ describe Pluggability do
 
 
 		it "still knows what the simplest version of its plugin name is" do
-			expect( SubSubPlugin.plugin_name ).to eq( 'subsub' )
+			expect( SubSubPlugin.plugin_name ).to eq( 'sub_sub' )
 		end
 
 	end

metadata

@@ -1,40 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: pluggability
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Michael Granger
 - Martin Chase
-autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIID+DCCAmCgAwIBAgIBBTANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
-  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMzAxMTYxNzE2MDlaFw0yNDAxMTYxNzE2
-  MDlaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
-  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
-  9w0BAQsFAAOCAYEARYCeUVBWARNKqF0cvNnLJvFf4hdW2+Rtc7NfC5jQvX9a1oom
-  sfVvS96eER/9cbrphu+vc59EELw4zT+RY3/IesnoE7CaX6zIOFmSmG7K61OHsSLR
-  KqMygcWwyuPXT2JG7JsGHuxbzgaRWe29HbSjBbLYxiMH8Zxh4tKutxzKF7jb0Ggq
-  KAf9MH5LwG8IHVIfV5drT14PvgR3tcvmrn1timPyJl+eZ3LNnm9ofOCweuZCq1cy
-  4Q8LV3vP2Cofy9q+az3DHdaUGlmMiZZZqKixDr1KSS9nvh0ZrKMOUL1sWj/IaxrQ
-  RV3y6td14q49t+xnbj00hPlbW7uE2nLJLt2NAoXiE1Nonndz1seB2c6HL79W9fps
-  E/O12pQjCp/aPUZMt8/8tKW31RIy/KP8XO6OTJNWA8A/oNEI0g5p/LmmEtJKWYr1
-  WmEdESlpWhzFECctefIF2lsN9vaOuof57RM77t2otrtcscDtNarIqjZsIyqtDvtL
-  DttITiit0Vwz7bY0
+  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQsFADA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  HhcNMjUwMTAxMDMzMTA5WhcNMjYwMTAxMDMzMTA5WjA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC/JWGRHO+USzR97vXjkFgt
+  83qeNf2KHkcvrRTSnR64i6um/ziin0I0oX23H7VYrDJC9A/uoUa5nGRJS5Zw/+wW
+  ENcvWVZS4iUzi4dsYJGY6yEOsXh2CcF46+QevV8iE+UmbkU75V7Dy1JCaUOyizEt
+  TH5UHsOtUU7k9TYARt/TgYZKuaoAMZZd5qyVqhF1vV+7/Qzmp89NGflXf2xYP26a
+  4MAX2qqKX/FKXqmFO+AGsbwYTEds1mksBF3fGsFgsQWxftG8GfZQ9+Cyu2+l1eOw
+  cZ+lPcg834G9DrqW2zhqUoLr1MTly4pqxYGb7XoDhoR7dd1kFE2a067+DzWC/ADt
+  +QkcqWUm5oh1fN0eqr7NsZlVJDulFgdiiYPQiIN7UNsii4Wc9aZqBoGcYfBeQNPZ
+  soo/6za/bWajOKUmDhpqvaiRv9EDpVLzuj53uDoukMMwxCMfgb04+ckQ0t2G7wqc
+  /D+K9JW9DDs3Yjgv9k4h7YMhW5gftosd+NkNC/+Y2CkCAwEAAaN1MHMwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFHKN/nkRusdqCJEuq3lgB3fJvyTg
+  MBwGA1UdEQQVMBOBEWdlZEBGYWVyaWVNVUQub3JnMBwGA1UdEgQVMBOBEWdlZEBG
+  YWVyaWVNVUQub3JnMA0GCSqGSIb3DQEBCwUAA4IBgQBjrBzCKWzXFigswYSPzGO8
+  9atBtY/eQdcN6KCL+PTzQBD9yePGF7H/xsww3awRauP+D1VUjCFbiiC3Qb0Ww0Qd
+  OVA0s10T9KpZ8nb2XyKocSK7TfgDhcyr0V4H2MPxwK9SWYjGGh8z9z9HmT0i3PyX
+  fXOSzzEoG6u26HIOg0nxSpitEjiAHBekQxy9ka5NuQbxoxMg+eIHU4rU9IUhu0Rf
+  wl4wuvPVE3UQK0v0uqT6rJukEKQ1iNgK5R8klgEIv79XhQPgTkMt31FGfrwOp6HB
+  OE0HMwOwY9B0w3aOxxdMQyyRxaZVv3eWE5RimQI7T0TUaxPngtS33ByMZjTeidxi
+  ESIUEPVXoBCkFgLW1EVlBb+rG7WLYod4eVll4tKA42Bi2Ju90tqiJ1YQiyuRfCnp
+  8qAqdfV+4u6Huu1KzAuDQCheyEyISsLST37sU/irV3czV6BiFipWag1XiJciRT3A
+  wZqCfTNVHTdtsCbfdA1DsA3RdG2iEH3TOHzv1Rqzqh4=
   -----END CERTIFICATE-----
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2025-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -100,7 +101,6 @@ metadata:
   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
@@ -115,8 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Pluggability is a toolkit for creating plugins.
 test_files: []