fiber-storage 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94e4cd24eb54f3ddde1331fa5900809a0a9dcdd6c93f0ea84c347813f70dd049
-  data.tar.gz: 94ed180a80d0879e3235a100eb47ef7e9286aad87f8b725a491733615ba5fc78
+  metadata.gz: 71c43018c492c0e23e2a1b78388e7df6406da28fe90e330206eb9e1d5623b1f5
+  data.tar.gz: f9097500200623a27c05f752062f0602daf5dd00f4b0d31971811c96119ecddd
 SHA512:
-  metadata.gz: a93d517e4f2ac212b71fefd8fc582d8fe2c9d08b43d7be907599cc9c33426011f6d479667d9bc7ae9d61a1d1d3533b2453944a2bcb1c28565fd189d64ee164c6
-  data.tar.gz: 393c7b732dc373de8e9dfcb4458d6224add7ed6ef983bf69eecfac0afadad019c72db49cc295523e472bbd467ca0d724fc8862967d6113e1fecc0dbe9d11fea4
+  metadata.gz: 1af6795e0b5b13d33cb9a5902195c956bc14f7966f17c3f6479da9626d5cebbe07d454e26a4cde60f2418ee7cf41d1483bf1b67fa918f03d90fe20322c3cd427
+  data.tar.gz: 3022888f880101f4ef125def7601607d5e8a605c5cae0796cdb15f337717c2fd99a55d4fd6ade1140b88f298e27e7dbe44a7e3741d1a013e395d7e8e6eddf3b2

data/lib/fiber/storage/version.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 require 'fiber'
 
 class Fiber
 	module Storage
-		VERSION = "0.1.2"
+		VERSION = "1.0.0"
 	end
 end

data/lib/fiber/storage.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 require 'fiber'
 
+# @namespace
 class Fiber
+	# Provides compatibility shims for fiber storage.
 	module Storage
+		# Initialize the fiber with the given storage.
 		def initialize(*arguments, storage: true, **options, &block)
 			case storage
 			when true
@@ -30,6 +33,7 @@ class Fiber
 			@storage.dup
 		end
 		
+		# @private
 		def __storage__
 			@storage ||= {}
 		end
@@ -52,6 +56,7 @@ class Fiber
 			self.current.__storage__[key] = value
 		end
 	else
+		# Whether the fiber storage has buggy keys. Unfortunately the original implementation of fiber storage was broken, this method detects the bug and is used to apply a fix.
 		def self.__borked_keys__
 			!Fiber.new do
 				key = :"#{self.object_id}.key"
@@ -61,13 +66,16 @@ class Fiber
 		end
 		
 		if __borked_keys__
+			# This is a fix for the original implementation of fiber storage which incorrectly handled non-dynamic symbol keys.
 			module FixBorkedKeys
+				# Lookup the value for the key, ensuring the symbol is dynamic.
 				def [](key)
 					raise TypeError, "Key must be symbol!" unless key.is_a?(Symbol)
 					
 					super(eval(key.inspect))
 				end
 				
+				# Assign the value to the key, ensuring the symbol is dynamic.
 				def []=(key, value)
 					raise TypeError, "Key must be symbol!" unless key.is_a?(Symbol)
 					

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2022-2023, by Samuel Williams.  
+Copyright, 2022-2024, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -12,4 +12,24 @@ Notably, it does not support inheritance across threads or lazy Enumerator. This
 
 ## Usage
 
-See the [project documentation](https://ioquatix.github.io/fiber-storage).
+Please see the [project documentation](https://ioquatix.github.io/fiber-storage/) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/fiber-storage/guides/getting-started/index) - This guide explains how to use this gem and provides a brief overview of the features.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiber-storage
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-15 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Provides a compatibility shim for fiber storage.