aw 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cef162831a9fd5958fa3123864f9db07d313f4a851b5738ce0f8bf171b12a570
-  data.tar.gz: 012f7e21a4a6282d4b998df713916509b7d34e4806d305c8878b1771833fc43f
+  metadata.gz: 72301167c4e8ea2ca3f8f2ab8bd7295822577c6539aeedf7bbc67b0feeb2eaf5
+  data.tar.gz: 0e4afe4ec73d3b19a3bdd2e644f2a45366ad9ac4ad73c7c57c7cd290face4639
 SHA512:
-  metadata.gz: ca3c0e6bb8c8fbf4ca45dc57d966cf4b5ca738f3d17936ceb055719b4e58ede5591c4a7208878ff8f0380dfad9d587f9dfd4ceed0d7135c82a3d1d9f9ff3ab62
-  data.tar.gz: 56152493f8c66f8b6316d0e12bafb8aaeda33c589a0fc2723cb2fa2767c705df5c4823436beab82a284a70adee6cdb90f938561ffed9244866705b3d7d014c88
+  metadata.gz: 72244a26c4a020ef1a5b185ca12d1d06dd87c3814d7acc55a3147f9df06eb414de9dbf4968d3e3d613d022d1475e48f7b60d52074e18047023e2fc6f02a0faa1
+  data.tar.gz: b6176b99c583a856bff7b98db9cbb9007b4ece7111b58739bfabab5c88324cde06581a46db4b9c8151ae7eb213abf05cc0210c57b7f04dcaf6beabcf299cec2c

data/LICENSE.md

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

@@ -1,64 +1,105 @@
 # 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! 😬
+> Aw, fork 😬
 
-Creates a subprocess to execute a block inside.
+![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
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'aw'
+gem "aw"
 ```
 
 And then execute:
 
-    $ bundle
+```sh
+bundle install
+```
 
 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:
+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
 ```
 
-Of course, it prevents from side effects:
+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"]
+Aw.fork! { arr << "FUU" } # => ["foo", "FUU"]
 
 arr # => ["foo"]
 ```
 
-Exceptions raised within the block are propagated:
+Exceptions raised in a block of code are propagated:
 
 ```ruby
-Aw.fork! { nil + 1 } # => NoMethodError (undefined method `+' for nil:NilClass)
+Aw.fork! { nil + 1 }
 ```
 
-## Contact
+results in the error:
+
+> `NoMethodError` (undefined method `+' for nil:NilClass)
 
-* Home page: https://github.com/fixrb/aw
-* Bugs/issues: https://github.com/fixrb/aw/issues
+### Method `.fork?`
 
-## Rubies
+Executes a block of code in a sub-process, and returns `true` if no exception is thrown:
+
+```ruby
+Aw.fork? { 6 * 7 } # => true
+```
 
-* [MRI](https://www.ruby-lang.org/)
-* [Rubinius](https://rubinius.com/)
+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 } # => false
+```
+
+## Contact
+
+* Source code: https://github.com/fixrb/aw
 
 ## Versioning
 
@@ -66,19 +107,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://github.com/fixrb/aw/raw/main/LICENSE.md).
 
 ***
 
 <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/fork.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-require 'English'
+require "English"
 
 module Aw
   # The Fork class.
+  #
+  # @api private
   class Fork
     # Initialize the class.
     #
@@ -11,7 +13,7 @@ module Aw
     # @param write [IO] The write endpoint.
     def initialize(read, write)
       # Currently, not available on all platforms.
-      raise ::NotImplementedError, 'fork()' unless ::Process.respond_to?(:fork)
+      raise ::NotImplementedError, "fork()" unless ::Process.respond_to?(:fork)
 
       @read   = read
       @write  = write
@@ -27,26 +29,34 @@ 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
+    #
+    # @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
       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
+      ::Process.fork do
+        # :nocov:
+
         read.close
 
         # rubocop:disable Lint/RescueException
@@ -58,7 +68,9 @@ module Aw
         # rubocop:enable Lint/RescueException
 
         ::Marshal.dump(result, write)
-        exit!(true)
+        ::Process.exit!(true)
+
+        # :nocov:
       end
     end
   end

data/lib/aw.rb

@@ -2,19 +2,48 @@
 
 # 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
+#
+# @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
-  # 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.
+  #
+  # @example Computes `6 * 7` in a sub-process and returns `42` to the current process.
+  #   Aw.fork! { 6 * 7 } # => 42
   #
-  # @param block [Proc] The code to run in a subprocess.
+  # @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 result.
+  # @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)
-    Fork.new(*::IO.pipe).call(&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')
+require_relative File.join("aw", "fork")

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: aw
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2022-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -66,35 +66,64 @@ dependencies:
     - - ">="
       - !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.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-description: Creates a subprocess to execute a block inside.
+        version: '0'
+description: Creates a sub-process to execute a block inside, and returns what it
+  returns (or a boolean).
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -107,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:
@@ -116,15 +146,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: "Aw, fork! \U0001F62C"
+summary: "Aw, fork \U0001F62C"
 test_files: []