mixins 0.1.0.pre.20250527171116 → 0.1.0.pre.20250529105050

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 931a539b8bc837e347f9e8daaaa3bbf457f48e4c320512be024bc591852f6ddd
-  data.tar.gz: 94ae6c7269ce07c2578499e51da76641b2b4df11caa5f76bc4dbd691ae61d43e
+  metadata.gz: e93930af24f01a0da060c8b7d39817f2a12dcde5d9b2057cf34f1c1851d624c3
+  data.tar.gz: 1c553f62f349fc8e97c5508efb00250f5b99333f36f5cfbc8f9a031029c637b7
 SHA512:
-  metadata.gz: 25a3c87aa1e640ecc6f9b05c48717434d184a0987b35b78e38c19c5c57b399e2f63be87be3239e56f01800bd17dadefe79dfaabf0cad9b3e4274513f473fe2fa
-  data.tar.gz: 56b6973f4de6917808a36e134575fe30c125f3ac6a9e03f3b507f4b2cae7c8b42ae40d032500d8c8e7f01d106c94811945e2dbd775ca70a2951eba9e141ae239
+  metadata.gz: 2a6dd68c2d5fc51d37816506520c6af967a822b5ac114975277080f78b9b5b76f48c64b489c19060b8c33f11690685e5b1c55f6a4872e8dfc1993cde05d7c773
+  data.tar.gz: 9a47fe11cf6223ddb354da6cee0bbb9a9f594b1c1acd9dc4ba6680e0af6302c88b792d6c1a92cb5203c908c801f415df698e272e2ab05e9c299e4e71b8d51182

data/README.md

@@ -54,11 +54,12 @@ This will install dependencies, and do any other necessary setup for development
 ## Authors
 
 - Michael Granger <ged@faeriemud.org>
+- Mahlon E. Smith <mahlon@martini.nu>
 
 
 ## License
 
-Copyright (c) 2025, Michael Granger
+Copyright (c) 2025, Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/lib/mixins/data_utilities.rb

@@ -8,8 +8,11 @@ require 'mixins' unless defined?( Mixins )
 # A collection of miscellaneous functions that are useful for manipulating
 # complex data structures.
 #
-#   include Ravn::DataUtilities
-#   newhash = deep_copy( oldhash )
+#     include Mixins::DataUtilities
+#     newhash = deep_copy( oldhash )
+#
+#     # or called as a module function
+#     newhash = Mixins::DataUtilities.deep_copy( oldhash )
 #
 module Mixins::DataUtilities
 

data/lib/mixins/datadir.rb

@@ -6,19 +6,35 @@ require 'rubygems'
 require 'mixins' unless defined?( Mixins )
 
 
-# When extended in a class, automatically set the path to a DATA_DIR
-# constant, derived from the class name.  Prefers environmental
+# Adds a #data_dir method and a DATA_DIR constant to extended objects. These
+# will be set to the `Pathname` to the data directory distributed with a gem of the
+# name derived from the `#name` of the extended object. Prefers environmental
 # override, Gem path, then local filesystem pathing.
 #
 # This can also be called manually if the including class name doesn't
 # match the gem, or something else esoteric.
 #
-# DATA_DIR is a Pathname object.
+#     require 'mixins'
+#
+#     class Acme
+#         extend Mixins::Datadir
+#     end
+#
+#     # When loading from checked-out source
+#     Rhizos.data_dir
+#     # => #<Pathname:../data/acme>
+#
+#     # With ACME_DATADIR=/path/to/data set in the environment before Ruby starts:
+#     Rhizos.data_dir
+#     # => #<Pathname:/path/to/data>
+#
+#     # When installed via gem
+#     Rhizos.data_dir
+#     # => #<Pathname:/path/to/lib/ruby/gems/3.4.0/gems/acme-1.0.0/data/acme>
 #
 module Mixins::Datadir
 
-	### Extend hook: Set the DATA_DIR constant in the extending
-	### class.
+	### Extend hook: Set up the `data_dir` accessor and the `DATA_DIR` constant
 	###
 	def self::extended( obj )
 		name = obj.name.downcase.gsub( '::', '-' )
@@ -30,10 +46,11 @@ module Mixins::Datadir
 	end
 
 
-	### Return a pathname object for the extended class DATA_DIR.  This
-	### allows for the DATA_DIR constant to be used transparently between
-	### development (local checkout) and production (gem installation)
-	### environments.
+	### Return a pathname object for the gem data directory. Use the `<gemname>_DATADIR`
+	### environment variable if it's set, or the data directory of the loaded gem if
+	### there is one. If neither of those are set, fall back to a relative path of
+	### `../../data/<gemname>`. You can override which environment variable is used for
+	### the override by setting +env+.
 	###
 	def self::find_datadir( gemname, env: nil )
 		unless env

data/lib/mixins/delegation.rb

@@ -10,18 +10,18 @@ module Mixins::Delegation
 	### Define the given +delegated_methods+ as delegators to the like-named method
 	### of the return value of the +delegate_method+.
 	###
-	###    class MyClass
-	###      extend Strelka::Delegation
+	###     class MyClass
+	###       extend Mixins::Delegation
 	###
-	###      # Delegate the #bound?, #err, and #result2error methods to the connection
-	###      # object returned by the #connection method. This allows the connection
-	###      # to still be loaded on demand/overridden/etc.
-	###      def_method_delegators :connection, :bound?, :err, :result2error
+	###       # Delegate the #bound?, #err, and #result2error methods to the connection
+	###       # object returned by the #connection method. This allows the connection
+	###       # to still be loaded on demand/overridden/etc.
+	###       def_method_delegators :connection, :bound?, :err, :result2error
 	###
-	###      def connection
-	###        @connection ||= self.connect
-	###      end
-	###    end
+	###       def connection
+	###         @connection ||= self.connect
+	###       end
+	###     end
 	###
 	def def_method_delegators( delegate_method, *delegated_methods )
 		delegated_methods.each do |name|
@@ -35,13 +35,13 @@ module Mixins::Delegation
 	### of the specified +ivar+. This is pretty much identical with how 'Forwardable'
 	### from the stdlib does delegation, but it's reimplemented here for consistency.
 	###
-	###    class MyClass
-	###      extend Strelka::Delegation
+	###     class MyClass
+	###       extend Mixins::Delegation
 	###
-	###      # Delegate the #each method to the @collection ivar
-	###      def_ivar_delegators :@collection, :each
+	###       # Delegate the #each method to the @collection ivar
+	###       def_ivar_delegators :@collection, :each
 	###
-	###    end
+	###     end
 	###
 	def def_ivar_delegators( ivar, *delegated_methods )
 		delegated_methods.each do |name|

data/lib/mixins/hooks.rb

@@ -5,24 +5,24 @@ require 'mixins' unless defined?( Mixins )
 
 # Methods for declaring hook methods.
 #
-#    class MyClass
-#        extend Mixins::Hooks
+#     class MyClass
+#         extend Mixins::Hooks
 #
-#        define_hook :before_fork
-#        define_hook :after_fork
-#    end
+#         define_hook :before_fork
+#         define_hook :after_fork
+#     end
 #
-#    MyClass.before_fork do
-#        @socket.close
-#    end
-#    MyClass.after_fork do
-#        @socket = Socket.new
-#    end
+#     MyClass.before_fork do
+#         @socket.close
+#     end
+#     MyClass.after_fork do
+#         @socket = Socket.new
+#     end
 #
-#    MyClass.run_before_fork_hook
-#    fork do
-#        MyClass.run_after_fork_hook
-#    end
+#     MyClass.run_before_fork_hook
+#     fork do
+#         MyClass.run_after_fork_hook
+#     end
 #
 #
 module Mixins::Hooks

data/lib/mixins/inspection.rb

@@ -4,6 +4,12 @@ require 'mixins' unless defined?( Mixins )
 
 
 # An extensible #inspect.
+#
+# This adds an overloaded #inspect method to including classes that provides
+# a way to easily extend the default #inspect output. To add your own output to
+# the body of the inspected object, implement the #inspect_details method and
+# return your desired output from it. By default it returns the empty string, which
+# will cause #inspect to use the default output.
 module Mixins::Inspection
 
 	### Return a human-readable representation of the object suitable for debugging.

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: mixins
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.20250527171116
+  version: 0.1.0.pre.20250529105050
 platform: ruby
 authors:
 - Michael Granger
+- Mahlon E. Smith
 bindir: bin
 cert_chain:
 - |
@@ -34,7 +35,7 @@ cert_chain:
   8qAqdfV+4u6Huu1KzAuDQCheyEyISsLST37sU/irV3czV6BiFipWag1XiJciRT3A
   wZqCfTNVHTdtsCbfdA1DsA3RdG2iEH3TOHzv1Rqzqh4=
   -----END CERTIFICATE-----
-date: 2025-05-27 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-deveiate
@@ -55,6 +56,7 @@ description: This is a collection of zero-dependency mixins. They’re intended
   dependencies.
 email:
 - ged@faeriemud.org
+- mahlon@martini.nu
 executables: []
 extensions: []
 extra_rdoc_files: []