aw 0.1.13 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af984fb0d47a9566b6ca5c9ac4a7208328cb444b504865e4fff631bb4122db7
-  data.tar.gz: 8c9759ef06861c6518cedd5867d85ebb04b62a01512a42abd94b401a3d67aa92
+  metadata.gz: 7e73149e7b499dddb359e9995c9cfe6b1af71d2bb63789f9bf0e13d029893b10
+  data.tar.gz: debe86862bee16a1902fb2c1b6448ba7d5bff733fa5ed0470cce4af5a2d30cb4
 SHA512:
-  metadata.gz: b950326ea7dc9a6846f079e75325e14d90d0261466dbd896dc57644eba8ef08ef8935364e756b6e41ed9f8b11cef68bb9752c9d3ad146daaf375f0b5334920d3
-  data.tar.gz: f21141ba62144f1b86ebead8c2816625c243272c51e671fcbdf95a28b8f81c8716dae4e7063427722094db3e661e8ceca2fdf757f2bf26612f9673dc35754b26
+  metadata.gz: 92954fad1db8bae390956d76c27cffb0fe399c55f2df5b16f102a2a69345a09b62d64a0694864036745f4cb4ceb89a7e143547d035da743e3abd22c0d1ffa14a
+  data.tar.gz: a1eb7a51f4bd7c068ace563f093e2ba94235067bd773a7921f6f175cf9a2a559ba045b9b54fe6f021b5b114ad33bdab48bbc0843ef617ea9fe42a386ae52ef79

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 Cyril Kato
+Copyright (c) 2015-2024 Cyril Kato
 
 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

@@ -1,14 +1,16 @@
 # Aw
 
-[![Version](https://img.shields.io/github/v/tag/fixrb/aw?label=Version&logo=github)](https://github.com/fixrb/aw/releases)
+[![Version](https://img.shields.io/github/v/tag/fixrb/aw?label=Version&logo=github)](https://github.com/fixrb/aw/tags)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/aw/main)
-[![CI](https://github.com/fixrb/aw/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/aw/actions?query=workflow%3Aci+branch%3Amain)
+[![Ruby](https://github.com/fixrb/aw/workflows/Ruby/badge.svg?branch=main)](https://github.com/fixrb/aw/actions?query=workflow%3Aruby+branch%3Amain)
 [![RuboCop](https://github.com/fixrb/aw/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/aw/actions?query=workflow%3Arubocop+branch%3Amain)
 [![License](https://img.shields.io/github/license/fixrb/aw?label=License&logo=github)](https://github.com/fixrb/aw/raw/main/LICENSE.md)
 
-> Aw, fork! 😬
+> Aw, fork 😬
 
-Creates a sub-process to execute a block inside, and return the result.
+![Aw](https://github.com/fixrb/aw/raw/main/img/aw.jpg)
+
+Creates a sub-process to execute a block inside, and returns what it returns (or a boolean).
 
 ## Installation
 
@@ -21,7 +23,7 @@ gem "aw"
 And then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
 Or install it yourself as:
@@ -32,26 +34,67 @@ gem install aw
 
 ## Usage
 
-Execute a block of code in a sub-process, and return the result to the current process:
+To make __Aw__ available:
+
+```ruby
+require "aw"
+```
+
+There are two methods:
+
+- `fork!`
+- `fork?`
+
+### Method `.fork!`
+
+Executes a block of code in a sub-process, and returns the result:
 
 ```ruby
 Aw.fork! { 6 * 7 } # => 42
 ```
 
-Therefore, when the execution of a block of code causes side effects, they are limited to the sub-process:
+When the execution of a block of code causes side effects, these are limited to the sub-process:
 
 ```ruby
-arr = ["foo"]
+arr = ["foo"] # => ["foo"]
 
 Aw.fork! { arr << "FUU" } # => ["foo", "FUU"]
 
 arr # => ["foo"]
 ```
 
-Exceptions raised within a block of code are propagated:
+Exceptions raised in a block of code are propagated:
+
+```ruby
+Aw.fork! { nil + 1 }
+```
+
+results in the error:
+
+> `NoMethodError` (undefined method `+' for nil:NilClass)
+
+### Method `.fork?`
+
+Executes a block of code in a sub-process, and returns `true` if no exception is thrown:
+
+```ruby
+Aw.fork? { 6 * 7 } # => true
+```
+
+When the execution of a block of code causes side effects, these are limited to the sub-process:
+
+```ruby
+arr = ["foo"] # => ["foo"]
+
+Aw.fork? { arr << "FUU" } # => true
+
+arr # => ["foo"]
+```
+
+When an exception is raised in a code block, `false` is returned:
 
 ```ruby
-Aw.fork! { nil + 1 } # => NoMethodError (undefined method `+' for nil:NilClass)
+Aw.fork? { nil + 1 } # => false
 ```
 
 ## Contact
@@ -64,7 +107,7 @@ __Aw__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The [gem](https://rubygems.org/gems/aw) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The [gem](https://rubygems.org/gems/aw) is available as open source under the terms of the [MIT License](https://github.com/fixrb/aw/raw/main/LICENSE.md).
 
 ***
 
@@ -72,5 +115,5 @@ The [gem](https://rubygems.org/gems/aw) is available as open source under the te
   This project is sponsored by:<br />
   <a href="https://sashite.com/"><img
     src="https://github.com/fixrb/aw/raw/main/img/sashite.png"
-    alt="Sashite" /></a>
+    alt="Sashité" /></a>
 </p>

data/lib/aw/fork.rb

@@ -34,9 +34,10 @@ module Aw
     # @example Computes `6 * 7` in a sub-process and returns `42` to the current process.
     #   call { 6 * 7 } # => 42
     #
-    # @return [#object_id] The computed value.
-    def call(&block)
-      pid = fork_and_return_pid(&block)
+    # @raise [Exception] Exceptions raised in a block of code are propagated.
+    # @return [#object_id] Returns the value that has been returned in the block.
+    def call(&)
+      pid = fork_and_return_pid(&)
       write.close
       result = read.read
       ::Process.wait(pid)
@@ -53,7 +54,7 @@ module Aw
     #
     # @return [Integer] The ID of the created sub-process.
     def fork_and_return_pid
-      fork do
+      ::Process.fork do
         # :nocov:
 
         read.close
@@ -67,7 +68,7 @@ module Aw
         # rubocop:enable Lint/RescueException
 
         ::Marshal.dump(result, write)
-        exit!(true)
+        ::Process.exit!(true)
 
         # :nocov:
       end

data/lib/aw.rb

@@ -5,19 +5,40 @@
 # @example Computes `6 * 7` in a sub-process and returns `42` to the current process.
 #   Aw.fork! { 6 * 7 } # => 42
 #
+# @example Computes `6 * 7` in a sub-process and returns `true` to the current process if no exception is thrown.
+#   Aw.fork? { 6 * 7 } # => true
+#
 # @api public
 module Aw
   # Runs the block inside a sub-process, and returns the computed value.
   #
-  # @param block [Proc] The code to run in a sub-process.
-  #
   # @example Computes `6 * 7` in a sub-process and returns `42` to the current process.
-  #   fork! { 6 * 7 } # => 42
+  #   Aw.fork! { 6 * 7 } # => 42
   #
-  # @return [#object_id] The computed value.
-  def self.fork!(&block)
+  # @example Computes `nil + 1` in a sub-process and raises `NoMethodError` to the current process.
+  #   Aw.fork! { nil + 1 } # => raise NoMethodError (undefined method `+' for nil:NilClass)
+  #
+  # @raise [Exception] Exceptions raised in a block of code are propagated.
+  # @return [#object_id] Returns the value that has been returned in the block.
+  def self.fork!(&)
     read, write = ::IO.pipe
-    Fork.new(read, write).call(&block)
+    Fork.new(read, write).call(&)
+  end
+
+  # Runs the block inside a sub-process, and returns `true` if no exception is
+  # thrown. Otherwise when an exception is raised, `false` is returned.
+  #
+  # @example Computes `6 * 7` in a sub-process and returns `true` to the current process.
+  #   Aw.fork? { 6 * 7 } # => true
+  #
+  # @example Computes `nil + 1` in a sub-process and returns `false` to the current process.
+  #   Aw.fork? { nil + 1 } # => false
+  #
+  # @return [Boolean] Returns `true` if stat is successful, `false` if not.
+  def self.fork?(&)
+    pid = ::Process.fork(&)
+    _, status = ::Process.wait2(pid)
+    status.success?
   end
 end
 

metadata

@@ -1,128 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: aw
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.2.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-md
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-thread_safety
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Creates a sub-process to execute a block inside, and returns the result.
+date: 2024-01-25 00:00:00.000000000 Z
+dependencies: []
+description: Creates a sub-process to execute a block inside, and returns what it
+  returns.
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -135,7 +24,8 @@ files:
 homepage: https://github.com/fixrb/aw
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -144,15 +34,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
-summary: "Aw, fork! \U0001F62C"
+summary: "Aw, fork \U0001F62C"
 test_files: []