[DRE-commits] [ruby-aruba] 22/74: Mark classes as private. There's an API method users can use

[Hideki Yamane]

This is an automated email from the git hooks/post-receive script.

henrich pushed a commit to branch debian/sid
in repository ruby-aruba.

commit 79a5c8cc57ccb3e6c2b400fd072155326d591814
Author: Dennis Günnewig <dg1 at ratiodata.de>
Date:   Tue Nov 24 10:36:40 2015 +0100

    Mark classes as private. There's an API method users can use
---
 History.md                           | 2 ++
 lib/aruba/processes/basic_process.rb | 5 +++++
 lib/aruba/processes/debug_process.rb | 8 +++++++-
 lib/aruba/processes/in_process.rb    | 7 +++++++
 lib/aruba/processes/null_process.rb  | 4 ++++
 lib/aruba/processes/spawn_process.rb | 7 +++++++
 6 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/History.md b/History.md
index 920d425..e863b12 100644
--- a/History.md
+++ b/History.md
@@ -442,6 +442,8 @@
 * Replace `<variable>` in commandline, e.g. `<pid-last-command-started>`
   [experimental]
 * Added announce formatter for time spans, e.g. `startup_wait_time`
+* All `*Process`-classes e.g. `BasicProcess`, `SpawnProcess` etc. are marked as
+  private. Users should use `#run('cmd')` and don't use the classes directly.
 
 ## [v1.0.0](https://github.com/cucumber/aruba/compare/v0.11.0...v1.0.0)
 
diff --git a/lib/aruba/processes/basic_process.rb b/lib/aruba/processes/basic_process.rb
index a7968b2..dc29dbd 100644
--- a/lib/aruba/processes/basic_process.rb
+++ b/lib/aruba/processes/basic_process.rb
@@ -3,6 +3,11 @@ require 'shellwords'
 
 module Aruba
   module Processes
+    # Basic Process
+    #
+    # `BasicProcess` is not meant for direct use - `BasicProcess.new` - by users.
+    #
+    # @private
     class BasicProcess
       attr_reader :exit_status, :environment, :startup_wait_time
 
diff --git a/lib/aruba/processes/debug_process.rb b/lib/aruba/processes/debug_process.rb
index f44e36b..afb7cc9 100644
--- a/lib/aruba/processes/debug_process.rb
+++ b/lib/aruba/processes/debug_process.rb
@@ -2,7 +2,13 @@ require 'aruba/processes/spawn_process'
 
 module Aruba
   module Processes
-    # Debug Process
+    # Run your command in `systemd()` to make debugging it easier
+    #
+    # `DebugProcess` is not meant for direct use - `InProcess.new` - by
+    # users. Only it's public methods are part of the public API of aruba, e.g.
+    # `#stdin`, `#stdout`.
+    #
+    # @private
     class DebugProcess < BasicProcess
       # Use only if mode is :debug
       def self.match?(mode)
diff --git a/lib/aruba/processes/in_process.rb b/lib/aruba/processes/in_process.rb
index 3b6fdf9..283d15b 100644
--- a/lib/aruba/processes/in_process.rb
+++ b/lib/aruba/processes/in_process.rb
@@ -5,6 +5,13 @@ require 'aruba/platform'
 
 module Aruba
   module Processes
+    # Run command in your ruby process
+    #
+    # `InProcess` is not meant for direct use - `InProcess.new` - by
+    # users. Only it's public methods are part of the public API of aruba, e.g.
+    # `#stdin`, `#stdout`.
+    #
+    # @private
     class InProcess < BasicProcess
       # Use only if mode is in_process
       def self.match?(mode)
diff --git a/lib/aruba/processes/null_process.rb b/lib/aruba/processes/null_process.rb
index 557cc5a..7904f3f 100644
--- a/lib/aruba/processes/null_process.rb
+++ b/lib/aruba/processes/null_process.rb
@@ -3,6 +3,10 @@ require 'aruba/processes/basic_process'
 module Aruba
   module Processes
     # Null Process
+    #
+    # `NullProcess` is not meant for direct use - `BasicProcess.new` - by users.
+    #
+    # @private
     class NullProcess < BasicProcess
       def self.match?(mode)
         mode == :null
diff --git a/lib/aruba/processes/spawn_process.rb b/lib/aruba/processes/spawn_process.rb
index c95ac24..7c62507 100644
--- a/lib/aruba/processes/spawn_process.rb
+++ b/lib/aruba/processes/spawn_process.rb
@@ -8,6 +8,13 @@ require 'aruba/platform'
 
 module Aruba
   module Processes
+    # Spawn a process for command
+    #
+    # `SpawnProcess` is not meant for direct use - `SpawnProcess.new` - by
+    # users. Only it's public methods are part of the public API of aruba, e.g.
+    # `#stdin`, `#stdout`.
+    #
+    # @private
     class SpawnProcess < BasicProcess
       # Use as default launcher
       def self.match?(mode)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-aruba.git