baal 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fd791002dfcce1998043d8c2933dfe4916f711f
-  data.tar.gz: 6eb46c2f1680ef7c4134452324139ad4589c4af1
+  metadata.gz: 19b0dedbcdd4ce8654c0323c2960995a1bd4c752
+  data.tar.gz: c1e69959059f0e8a0dc3ada73118203488019e4e
 SHA512:
-  metadata.gz: 9242ed3fc57795d76a102afa72f3cd3eeb2d859461efcdea523109d4e8461ea216baac53137aeea4c57ce0fe5d2878b1075bede930dd77ac7015770bd09586fb
-  data.tar.gz: e70d24a8b3af1051f6af9cab25058b131969bb6b3d97ed6662f7fc35bcd7b23085e246e779aae1b7fe83bc94e6b4cc0d1536e0c9adbcdbbca9f12a0298c251ca
+  metadata.gz: 1316659592b8eb859a6149d41912a0d46bd8964b93ba17932bfc5208cfbc25fce73f32855cf123ac34e51d6351368b7b746d2e5504bc667649efd1ae792ad3bb
+  data.tar.gz: 672cf32efaef3619336a2214f39192557f4828482cf6161576f3ff796509b320602eaf2ce3bb9e695f5ec8bfe42bc9d6750d7f0ccca65b7e1170bf0b9c3d1ea3

data/README.md

@@ -24,19 +24,20 @@ Or install it yourself as:
 
 The intention of Baal is to provide an easily-readable, step-by-step process of building start-stop-daemon scripts.
 
-The wrapper provides all methods you are used to and attempts to alert you (with a nice red error) if it notices a mistake.
+The wrapper provides all of the methods you are used to and attempts to alert you (with a nice red error) if it notices
+a mistake.
 
 All building is centered around the Daemon object which can be accessed like so:
 
 ```ruby
-# Preferred
+# Better
 daemon = Baal.new
 
-# Not preferred
+# Okay
 daemon = Baal::Daemon.new
 ```
 
-Once you have your builder object, it is simply a matter of constructing the needed commands and options.
+Once you have your builder object, it is simply a matter of constructing the needed commands and options:
 
 ```ruby
 # Start a new process in the background
@@ -45,19 +46,19 @@ daemon.instance_of_exec('/abs/path/to/executable')
 daemon.with_name('dave')
 ```
 
-Then execute what you have built
+Then execute what you have built:
 
 ```ruby
 daemon.daemonize!
 ```
 
-You can even check the current status of what you are to execute
+You can even check the current status of what you are to execute:
 
 ```ruby
 puts daemon.execution
 ```
 
-You can also clear the current contents of what you have built up
+You can also clear the current contents of what you have built up:
 
 ```ruby
 # Begin with start
@@ -69,37 +70,36 @@ daemon.pid_file('/path/to/pid_file')
 daemon.clear_all!
 ```
 
-
-All of the methods that build up your start-stop-daemon script are chain-able
+All of the methods that build up your start-stop-daemon script are chain-able:
 
 ```ruby
 # Check the status of a process
 daemon.status.with_pid(1234).daemonize!
 ```
 
-All options with dashes have been converted to underscores, ie.
+All options with dashes have been converted to underscores:
 
 ```ruby
-# From
+# "Original" (no options for this)
 daemon.make-pidfile
 
-# To
+# Baal's
 daemon.make_pidfile
 ```
  
-and there are many methods that have been written to be more Ruby-like, however, if you still prefer the original
-command and option names (dashes are not allowed), those are available as well 
+There are many methods that have been written to be more Ruby-like, however, if you still prefer the original
+command and option names (dashes are not allowed), those are available as well:
 
 ```ruby
-# These are just options...
+# Baal's
 daemon.start.start_as('/p/a/t/h').pid_file('/p/a/t/h').change_to_user('dave')
 
-# Original language
+# Original
 daemon.start.startas('/p/a/t/h').pidfile('/p/a/t/h').chuid('dave')
 
 # No option for multi-word options with dashes
-daemon.make-pidfile # No method
-daemon.make_pidfile # As above
+daemon.no-close # Error: No method available
+daemon.no_close # Dashes converted to underscores
 ```
 
 The documentation in the library should be enough, but if it isn't, or you just don't like my writing style, then there

data/lib/baal.rb

@@ -2,6 +2,7 @@ require 'baal/version'
 require 'baal/commands'
 require 'baal/matching_options'
 require 'baal/optional_options'
+require 'open3'
 
 # The Baal module is the namespace containing all interaction with the Baal gem.
 # Very little is actually done directly on the Baal module. The primary
@@ -34,18 +35,18 @@ module Baal
 
     PROGRAM_NAME = 'start-stop-daemon'.freeze
 
+    attr_reader :stdout, :stderr, :std_status
+
     def initialize
-      @execution = [PROGRAM_NAME]
-      @testing = false
+      @commands_and_opts = []
     end
 
     # TODO: Add method to remove a single command or option
 
-    # Clears @execution and starts over with only the PROGRAM_NAME
+    # Clears @commands_and_opts and starts over with only the PROGRAM_NAME
     #
     def clear_all!
-      @execution.clear
-      @execution = [PROGRAM_NAME]
+      @commands_and_opts.clear
       self
     end
 
@@ -53,23 +54,21 @@ module Baal
     #   string to be executed
     #
     def execution
-      @execution.join(' ').strip
+      ([PROGRAM_NAME] + @commands_and_opts).join(' ').strip
     end
 
     # Executes the built up start-stop-daemon string and throws an error if
     # there isn't at least one command and at least one matching option.
     #
-    # @return [true, false, nil]
-    #    true: if command was successful (exit status 0)
-    #   false: if command was unsuccessful (exit status non-zero)
-    #     nil: if command execution fails
-    #
-    # TODO: remove usage of system
+    # @return [nil] returns nil to force user to interact with the attr methods
+    #   for the system output vs the array that would be returned if nil was
+    #   not used
     #
     def daemonize!
       at_least_one_command?
       at_least_one_matching_option?
-      system @execution
+      @stdout, @stderr, @std_status = Open3.capture3(PROGRAM_NAME, *@commands_and_opts)
+      nil
     end
   end
 end

data/lib/baal/commands.rb

@@ -28,7 +28,7 @@ module Baal
     #    II. start_as: a path_name to a process
     #
     def start
-      @execution.insert 1, COMMANDS[:start]
+      @commands_and_opts.unshift COMMANDS[:start]
       include_multiple_commands?
       self
     end
@@ -52,7 +52,7 @@ module Baal
     #     retry: option to check whether or not process(es) finish
     #
     def stop
-      @execution.insert 1, COMMANDS[:stop]
+      @commands_and_opts.unshift COMMANDS[:stop]
       include_multiple_commands?
       self
     end
@@ -62,14 +62,14 @@ module Baal
     # exists. An exit code is returned accord to the LSB Init Script Actions.
     # TODO: provide better error messages based on LSB.
     def status
-      @execution.insert 1, COMMANDS[:status]
+      @commands_and_opts.unshift COMMANDS[:status]
       include_multiple_commands?
       self
     end
 
     # Command that shows cli help information and then exits.
     def help
-      @execution.insert 1, COMMANDS[:help]
+      @commands_and_opts.unshift COMMANDS[:help]
       include_multiple_commands?
       self
     end
@@ -77,7 +77,7 @@ module Baal
     # Command that shows your program version of start-stop-daemon and then
     # exits.
     def version
-      @execution.insert 1, COMMANDS[:version]
+      @commands_and_opts.unshift COMMANDS[:version]
       include_multiple_commands?
       self
     end

data/lib/baal/matching_options.rb

@@ -26,7 +26,7 @@ module Baal
     # TODO: Add error to catch for 0 or less.
     #
     def pid(id)
-      @execution.push "#{MATCHING_OPTIONS[:pid]}=#{id}"
+      @commands_and_opts.push "#{MATCHING_OPTIONS[:pid]}=#{id}"
       self
     end
     alias with_pid pid
@@ -38,7 +38,7 @@ module Baal
     # TODO: Add error to catch for 0 or less.
     #
     def ppid(id)
-      @execution.push "#{MATCHING_OPTIONS[:ppid]}=#{id}"
+      @commands_and_opts.push "#{MATCHING_OPTIONS[:ppid]}=#{id}"
       self
     end
     alias with_ppid ppid
@@ -52,7 +52,7 @@ module Baal
     #          unintended consequences.
     #
     def pid_file(path)
-      @execution.push "#{MATCHING_OPTIONS[:pid_file]}=#{path}"
+      @commands_and_opts.push "#{MATCHING_OPTIONS[:pid_file]}=#{path}"
       self
     end
     alias with_pid_file pid_file
@@ -73,7 +73,7 @@ module Baal
     #          avoid this.
     #
     def exec(abs_path_to_exec)
-      @execution.push "#{MATCHING_OPTIONS[:exec]}=#{abs_path_to_exec}"
+      @commands_and_opts.push "#{MATCHING_OPTIONS[:exec]}=#{abs_path_to_exec}"
       self
     end
     alias instance_of_exec exec
@@ -90,7 +90,7 @@ module Baal
     #       of the expected process name that is 15 characters long.
     #
     def name(process_name)
-      @execution.push "#{MATCHING_OPTIONS[:name]}=#{process_name}"
+      @commands_and_opts.push "#{MATCHING_OPTIONS[:name]}=#{process_name}"
       self
     end
     alias with_name name
@@ -103,7 +103,7 @@ module Baal
     #          processes to be acted upon.
     #
     def user(username_or_uid)
-      @execution.push "#{MATCHING_OPTIONS[:user]}=#{username_or_uid}"
+      @commands_and_opts.push "#{MATCHING_OPTIONS[:user]}=#{username_or_uid}"
       self
     end
     alias username user

data/lib/baal/optional_options.rb

@@ -36,7 +36,7 @@ module Baal
     #   id to be changed to
     #
     def group(group_name_or_gid)
-      @execution.push "#{OPTIONAL_OPTS[:group]}=#{group_name_or_gid}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:group]}=#{group_name_or_gid}"
       self
     end
     alias group_name group
@@ -51,7 +51,7 @@ module Baal
     # @param signal[String, Symbol] the signal to send
     #
     def signal(signal = 'TERM')
-      @execution.push "#{OPTIONAL_OPTS[:signal]}=#{signal}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:signal]}=#{signal}"
       self
     end
     alias with_signal signal
@@ -86,7 +86,7 @@ module Baal
     # TODO: Add better arguments for constructing a schedule
     #
     def retry(timeout_or_schedule)
-      @execution.push "#{OPTIONAL_OPTS[:retry]}=#{timeout_or_schedule}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:retry]}=#{timeout_or_schedule}"
       self
     end
     alias retry_timeout retry
@@ -101,7 +101,7 @@ module Baal
     # @param path [String] path to process to attempt to start as
     #
     def start_as(path)
-      @execution.push "#{OPTIONAL_OPTS[:start_as]}=#{path}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:start_as]}=#{path}"
       self
     end
     alias startas start_as
@@ -110,7 +110,7 @@ module Baal
     # but take no action
     #
     def test
-      @execution.push OPTIONAL_OPTS[:test]
+      @commands_and_opts.push OPTIONAL_OPTS[:test]
       self
     end
 
@@ -118,14 +118,14 @@ module Baal
     # be, taken
     #
     def oknodo
-      @execution.push OPTIONAL_OPTS[:oknodo]
+      @commands_and_opts.push OPTIONAL_OPTS[:oknodo]
       self
     end
 
     # Do not print informational messages; only display error messages
     #
     def quiet
-      @execution.push OPTIONAL_OPTS[:quiet]
+      @commands_and_opts.push OPTIONAL_OPTS[:quiet]
       self
     end
 
@@ -146,7 +146,7 @@ module Baal
     #
     def chuid(username_or_uid, group_or_gid = nil)
       group_or_gid = group_or_gid.nil? ? '' : ":#{group_or_gid}"
-      @execution.push "#{OPTIONAL_OPTS[:chuid]}=#{username_or_uid}#{group_or_gid}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:chuid]}=#{username_or_uid}#{group_or_gid}"
       self
     end
     alias change_to_user chuid
@@ -159,7 +159,7 @@ module Baal
     # NOTE: the pid_file is written after the chroot
     #
     def chroot(new_root_dir)
-      @execution.push "#{OPTIONAL_OPTS[:chroot]}=#{new_root_dir}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:chroot]}=#{new_root_dir}"
       self
     end
 
@@ -170,19 +170,19 @@ module Baal
     # chdir to the root directory before starting the process.
     #
     def chdir(path)
-      @execution.push "#{OPTIONAL_OPTS[:chdir]}=#{path}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:chdir]}=#{path}"
       self
     end
 
     def background
-      @execution.push OPTIONAL_OPTS[:background]
+      @commands_and_opts.push OPTIONAL_OPTS[:background]
       self
     end
     alias in_background background
 
     # Only relevant when using --background
     def no_close
-      @execution.push OPTIONAL_OPTS[:no_close]
+      @commands_and_opts.push OPTIONAL_OPTS[:no_close]
       self
     end
 
@@ -192,7 +192,7 @@ module Baal
     #   positive or negative
     #
     def nice_level(incr)
-      @execution.push "#{OPTIONAL_OPTS[:nice_level]}=#{incr}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:nice_level]}=#{incr}"
       self
     end
     alias incr_nice_level nice_level
@@ -213,7 +213,7 @@ module Baal
       end
 
       priority = priority.nil? ? ' ' : ":#{priority}"
-      @execution.push "#{OPTIONAL_OPTS[:proc_sched]}=#{policy}#{priority}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:proc_sched]}=#{policy}#{priority}"
       self
     end
     alias procshed proc_sched
@@ -238,7 +238,7 @@ module Baal
       end
 
       priority = priority.nil? ? ' ' : ":#{priority}"
-      @execution.push "#{OPTIONAL_OPTS[:io_sched]}=#{sched_class}#{priority}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:io_sched]}=#{sched_class}#{priority}"
       self
     end
     alias iosched io_sched
@@ -248,7 +248,7 @@ module Baal
     #
     # @param mask [String, Integer] umask value
     def umask(mask)
-      @execution.push "#{OPTIONAL_OPTS[:umask]}=#{mask}"
+      @commands_and_opts.push "#{OPTIONAL_OPTS[:umask]}=#{mask}"
       self
     end
 
@@ -269,7 +269,7 @@ module Baal
     #          OptionalOptions#background option.
     #
     def make_pid_file
-      @execution.push OPTIONAL_OPTS[:make_pid_file]
+      @commands_and_opts.push OPTIONAL_OPTS[:make_pid_file]
       self
     end
     alias make_pidfile make_pid_file
@@ -283,14 +283,14 @@ module Baal
     # option.
     #
     def remove_pid_file
-      @execution.push OPTIONAL_OPTS[:remove_pid_file]
+      @commands_and_opts.push OPTIONAL_OPTS[:remove_pid_file]
       self
     end
     alias remove_pidfile remove_pid_file
 
     # Print verbose informational messages when executing the script
     def verbose
-      @execution.push OPTIONAL_OPTS[:verbose]
+      @commands_and_opts.push OPTIONAL_OPTS[:verbose]
       self
     end
   end

data/lib/baal/version.rb

@@ -1,3 +1,3 @@
 module Baal
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lukas Nimmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler