aw 0.1.13 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af984fb0d47a9566b6ca5c9ac4a7208328cb444b504865e4fff631bb4122db7
-  data.tar.gz: 8c9759ef06861c6518cedd5867d85ebb04b62a01512a42abd94b401a3d67aa92
+  metadata.gz: 72301167c4e8ea2ca3f8f2ab8bd7295822577c6539aeedf7bbc67b0feeb2eaf5
+  data.tar.gz: 0e4afe4ec73d3b19a3bdd2e644f2a45366ad9ac4ad73c7c57c7cd290face4639
 SHA512:
-  metadata.gz: b950326ea7dc9a6846f079e75325e14d90d0261466dbd896dc57644eba8ef08ef8935364e756b6e41ed9f8b11cef68bb9752c9d3ad146daaf375f0b5334920d3
-  data.tar.gz: f21141ba62144f1b86ebead8c2816625c243272c51e671fcbdf95a28b8f81c8716dae4e7063427722094db3e661e8ceca2fdf757f2bf26612f9673dc35754b26
+  metadata.gz: 72244a26c4a020ef1a5b185ca12d1d06dd87c3814d7acc55a3147f9df06eb414de9dbf4968d3e3d613d022d1475e48f7b60d52074e18047023e2fc6f02a0faa1
+  data.tar.gz: b6176b99c583a856bff7b98db9cbb9007b4ece7111b58739bfabab5c88324cde06581a46db4b9c8151ae7eb213abf05cc0210c57b7f04dcaf6beabcf299cec2c

data/LICENSE.md

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

@@ -6,9 +6,11 @@
 [![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).
 
 ***
 

data/lib/aw/fork.rb

@@ -34,7 +34,8 @@ 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.
+    # @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(&block)
       pid = fork_and_return_pid(&block)
       write.close
@@ -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,6 +5,9 @@
 # @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.
@@ -12,13 +15,35 @@ module Aw
   # @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
+  #
+  # @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)
   #
-  # @return [#object_id] The computed value.
+  # @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!(&block)
     read, write = ::IO.pipe
     Fork.new(read, write).call(&block)
   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.
+  #
+  # @param block [Proc] The code to run in a sub-process.
+  #
+  # @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?(&block)
+    pid = ::Process.fork(&block)
+    _, status = ::Process.wait2(pid)
+    status.success?
+  end
 end
 
 require_relative File.join("aw", "fork")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aw
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.2.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2022-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Creates a sub-process to execute a block inside, and returns the result.
+description: Creates a sub-process to execute a block inside, and returns what it
+  returns (or a boolean).
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -135,7 +136,8 @@ files:
 homepage: https://github.com/fixrb/aw
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -154,5 +156,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: "Aw, fork! \U0001F62C"
+summary: "Aw, fork \U0001F62C"
 test_files: []