aw 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82f2e2afc9696e62695257eba13de54c57617c9010b159a6c3cf06c6b9a532c7
-  data.tar.gz: 590c6a707c82d901ba98deaf74bd7e67ee8a11cec073a0e805cc70d237f09f31
+  metadata.gz: 9af984fb0d47a9566b6ca5c9ac4a7208328cb444b504865e4fff631bb4122db7
+  data.tar.gz: 8c9759ef06861c6518cedd5867d85ebb04b62a01512a42abd94b401a3d67aa92
 SHA512:
-  metadata.gz: b7b22077b6f5ee1f082255226d4abf8bf5104c616df19efec6c9b04f1ca7ebf8644fbd5f0e3666950b8ccead2d958a2956bda5b22751f26a27e18cc8bd0aa5e0
-  data.tar.gz: 1696982963c47a63199069744faef8f6fe96b592f9fb052f188a6d81f6113d277230beed5b3fe8e4b182b03e7550a7246a31737c0dd7021df99894a8412f7508
+  metadata.gz: b950326ea7dc9a6846f079e75325e14d90d0261466dbd896dc57644eba8ef08ef8935364e756b6e41ed9f8b11cef68bb9752c9d3ad146daaf375f0b5334920d3
+  data.tar.gz: f21141ba62144f1b86ebead8c2816625c243272c51e671fcbdf95a28b8f81c8716dae4e7063427722094db3e661e8ceca2fdf757f2bf26612f9673dc35754b26

data/README.md

@@ -1,14 +1,14 @@
 # Aw
 
-[![Build Status](https://api.travis-ci.org/fixrb/aw.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/fixrb/aw/badges/gpa.svg)][codeclimate]
-[![Gem Version](https://badge.fury.io/rb/aw.svg)][gem]
-[![Inline docs](https://inch-ci.org/github/fixrb/aw.svg?branch=master)][inchpages]
-[![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+[![Version](https://img.shields.io/github/v/tag/fixrb/aw?label=Version&logo=github)](https://github.com/fixrb/aw/releases)
+[![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)
+[![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! 😬
 
-Creates a subprocess to execute a block inside.
+Creates a sub-process to execute a block inside, and return the result.
 
 ## Installation
 
@@ -20,21 +20,25 @@ gem "aw"
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install aw
+```sh
+gem install aw
+```
 
 ## Usage
 
-It executes the block in a subprocess, and returns the result in the current process:
+Execute a block of code in a sub-process, and return the result to the current process:
 
 ```ruby
 Aw.fork! { 6 * 7 } # => 42
 ```
 
-Of course, it prevents from side effects:
+Therefore, when the execution of a block of code causes side effects, they are limited to the sub-process:
 
 ```ruby
 arr = ["foo"]
@@ -44,7 +48,7 @@ Aw.fork! { arr << "FUU" } # => ["foo", "FUU"]
 arr # => ["foo"]
 ```
 
-Exceptions raised within the block are propagated:
+Exceptions raised within a block of code are propagated:
 
 ```ruby
 Aw.fork! { nil + 1 } # => NoMethodError (undefined method `+' for nil:NilClass)
@@ -60,19 +64,13 @@ __Aw__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The gem 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://opensource.org/licenses/MIT).
 
 ***
 
 <p>
   This project is sponsored by:<br />
   <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/aw/raw/master/img/sashite.png"
+    src="https://github.com/fixrb/aw/raw/main/img/sashite.png"
     alt="Sashite" /></a>
 </p>
-
-[gem]: https://rubygems.org/gems/aw
-[travis]: https://travis-ci.org/fixrb/aw
-[codeclimate]: https://codeclimate.com/github/fixrb/aw
-[inchpages]: https://inch-ci.org/github/fixrb/aw
-[rubydoc]: https://rubydoc.info/gems/aw

data/lib/aw.rb

@@ -2,18 +2,22 @@
 
 # Namespace for the Aw library.
 #
-# @api public
-#
-# @example Fork and return 42 from 6 * 7.
+# @example Computes `6 * 7` in a sub-process and returns `42` to the current process.
 #   Aw.fork! { 6 * 7 } # => 42
+#
+# @api public
 module Aw
-  # Run the block inside a subprocess, and return the value.
+  # Runs the block inside a sub-process, and returns the computed value.
+  #
+  # @param block [Proc] The code to run in a sub-process.
   #
-  # @param block [Proc] The code to run in a subprocess.
+  # @example Computes `6 * 7` in a sub-process and returns `42` to the current process.
+  #   fork! { 6 * 7 } # => 42
   #
-  # @return [#object_id] The result.
+  # @return [#object_id] The computed value.
   def self.fork!(&block)
-    Fork.new(*::IO.pipe).call(&block)
+    read, write = ::IO.pipe
+    Fork.new(read, write).call(&block)
   end
 end
 

data/lib/aw/fork.rb

@@ -4,6 +4,8 @@ require "English"
 
 module Aw
   # The Fork class.
+  #
+  # @api private
   class Fork
     # Initialize the class.
     #
@@ -27,26 +29,33 @@ module Aw
     # @return [IO] The write endpoint.
     attr_reader :write
 
-    # Run the block inside a subprocess, and return the value.
+    # Runs the block inside a sub-process, and returns the computed value.
     #
-    # @return [#object_id] The result.
-    def call(*, **, &block)
+    # @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)
       write.close
       result = read.read
       ::Process.wait(pid)
 
       # rubocop:disable Security/MarshalLoad
-      ::Marshal.load(result).tap do |r|
-        raise r if r.is_a?(::Exception)
-      end
+      ::Marshal.load(result).tap { |r| raise r if r.is_a?(::Exception) }
       # rubocop:enable Security/MarshalLoad
     end
 
     private
 
+    # Creates a sub-process to execute a block inside, and returns the
+    # sub-process ID.
+    #
+    # @return [Integer] The ID of the created sub-process.
     def fork_and_return_pid
       fork do
+        # :nocov:
+
         read.close
 
         # rubocop:disable Lint/RescueException
@@ -59,6 +68,8 @@ module Aw
 
         ::Marshal.dump(result, write)
         exit!(true)
+
+        # :nocov:
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aw
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Creates a subprocess to execute a block inside.
+description: Creates a sub-process to execute a block inside, and returns the result.
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: "Aw, fork! \U0001F62C"