sus-fixtures-async 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef6fa66687b3e56d258150697f05dcf1ef032f02aeb1c14396d744b3c3bed799
-  data.tar.gz: a7a81a13b19cb5790f963678a77c1168bc0acfa82241cf0bff7b04d4c8bb48f1
+  metadata.gz: e0f93349ce0e3cfae2ab926d9e9196839cf8ae715f446355531fff5f7613a2f9
+  data.tar.gz: e7f80e88e911fb2c90289eded998b6ff413591766d7f5505ebdffad963df777e
 SHA512:
-  metadata.gz: 4c2e4e69bf322d633e7cc31a1c83ee84dd8485d3044b69c6eb71d42d5642775a38715a67b8038c13d956c68f6df3ede7bf5104cf407c7d96854e7cec0b68c717
-  data.tar.gz: 1bf612d6af84298f277c52be7fd1923e61f453410bcebffca06835ab635eb2cb2fdd387135a6c1053dd0d55e20c98cea81546935dd0f5365893917220821abdd
+  metadata.gz: 0f2b464e361a0f6c78aca01ca26925b5e80a46ac53d0926076788bdd725290343b0a3b8f648014071dcdc9ff680d60578621daea0e09fbacaccd349cbac1eb4b
+  data.tar.gz: 2bdc028ac0ca0f9bbe66a6e12db20411aefb02265f7bb6f6ae9dce5ab4e78875171788cb1072afa590ab04fcd1b5d730cb8532d3abf7ab7e05b5c85e233ce62e

data/lib/sus/fixtures/async/reactor_context.rb

@@ -1,74 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'async'
-require 'sus/fixtures'
+require_relative 'scheduler_context'
 
 module Sus::Fixtures::Async
-	module ReactorContext
-		def run_with_timeout(timeout = nil, &block)
-			task = ::Async::Task.current
-			
-			result = nil
-			timer_task = nil
-			
-			if timeout
-				timer_task = task.async(transient: true) do |task|
-					# Wait for the timeout, at any point this task might be cancelled if the user code completes:
-					task.annotate("Timer task timeout=#{timeout}.")
-					task.sleep(timeout)
-					
-					# The timeout expired, so generate an error:
-					buffer = StringIO.new
-					task.reactor.print_hierarchy(buffer)
-					
-					# Raise an error so it is logged:
-					raise Async::TimeoutError, "Run time exceeded timeout #{timeout}s:\n#{buffer.string}"
-				end
-			end
-			
-			spec_task = task.async do |spec_task|
-				spec_task.annotate("running example")
-				
-				begin
-					result = yield(spec_task)
-				ensure
-					# We are finished, so stop the timer task if it was started:
-					timer_task&.stop
-				end
-				
-				# Now stop the entire reactor:
-				raise Async::Stop
-			end
-			
-			begin
-				timer_task&.wait
-				spec_task.wait
-			ensure
-				spec_task.stop
-			end
-			
-			return result
-		end
-		
-		def timeout
-			60
-		end
-		
-		def reactor
-			Async::Task.current.reactor
-		end
-		
-		def around(&block)
-			Sync do |task|
-				task.annotate(self.class)
-				
-				run_with_timeout(self.timeout) do
-					super(&block)
-				end
-			end
-		end
-	end
+	ReactorContext = SchedulerContext
 end

data/lib/sus/fixtures/async/scheduler_context.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'async'
+require 'sus/fixtures'
+
+module Sus::Fixtures::Async
+	module SchedulerContext
+		def run_with_timeout(timeout = nil, &block)
+			task = ::Async::Task.current
+			
+			result = nil
+			timer_task = nil
+			
+			if timeout
+				timer_task = task.async(transient: true) do |task|
+					# Wait for the timeout, at any point this task might be cancelled if the user code completes:
+					task.annotate("Timer task timeout=#{timeout}.")
+					task.sleep(timeout)
+					
+					# The timeout expired, so generate an error:
+					buffer = StringIO.new
+					scheduler.print_hierarchy(buffer)
+					
+					# Raise an error so it is logged:
+					raise Async::TimeoutError, "Run time exceeded timeout #{timeout}s:\n#{buffer.string}"
+				end
+			end
+			
+			spec_task = task.async do |spec_task|
+				spec_task.annotate("running example")
+				
+				begin
+					result = yield(spec_task)
+				ensure
+					# We are finished, so stop the timer task if it was started:
+					timer_task&.stop
+				end
+				
+				# Now stop the scheduler:
+				raise Async::Stop
+			end
+			
+			begin
+				timer_task&.wait
+				spec_task.wait
+			ensure
+				spec_task.stop
+			end
+			
+			return result
+		end
+		
+		def timeout
+			60
+		end
+		
+		def scheduler
+			Fiber.scheduler
+		end
+		
+		alias reactor scheduler
+		
+		def around(&block)
+			Sync do |task|
+				task.annotate(self.class)
+				
+				run_with_timeout(self.timeout) do
+					# This ensures all before/after blocks are also run in the scheduler context.
+					super(&block)
+				end
+			end
+		end
+	end
+end

data/lib/sus/fixtures/async/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.
 
 module Sus
 	module Fixtures
 		module Async
-			VERSION = "0.1.3"
+			VERSION = "0.2.0"
 		end
 	end
 end

data/lib/sus/fixtures/async.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
+require_relative 'async/version'
 require_relative 'async/reactor_context'

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

@@ -2,23 +2,28 @@
 
 Provides a convenient fixture for testing async components in a reactor.
 
-[![Development Status](https://github.com/socketry/sus-fixtures-async/workflows/Test/badge.svg)](https://github.com/socketry/sus-fixtures-async/actions?workflow=Test)
+[![Development Status](https://github.com/suspecting/sus-fixtures-async/workflows/Test/badge.svg)](https://github.com/suspecting/sus-fixtures-async/actions?workflow=Test)
 
-## Installation
+## Usage
 
-``` bash
-$ bundle add sus-fixtures-async
-```
+Please see the [project documentation](https://socketry.github.io/sus-fixtures-async/) for more details.
 
-## Usage
+  - [Getting Started](https://socketry.github.io/sus-fixtures-async/guides/getting-started/index) - This guide explains how to use the `sus-fixtures-async` gem to test async components in a reactor.
+
+## 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
 
-``` ruby
-include Sus::Fixtures::Async::ReactorContext
+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.
 
-# Override the default timeout
-def timeout = 1
+### Community Guidelines
 
-it 'it runs in a reactor' do
-	expect(Async::Task.current).not.to be == nil
-end
-```
+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: sus-fixtures-async
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2024-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -75,14 +75,17 @@ extra_rdoc_files: []
 files:
 - lib/sus/fixtures/async.rb
 - lib/sus/fixtures/async/reactor_context.rb
+- lib/sus/fixtures/async/scheduler_context.rb
 - lib/sus/fixtures/async/version.rb
 - license.md
 - readme.md
-homepage: https://github.com/ioquatix/sus-fixtures-async
+homepage: https://github.com/socketry/sus-fixtures-async
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://socketry.github.io/sus-fixtures-async/
   funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/sus-fixtures-async.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -91,14 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Test fixtures for running in Async.