libexec 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3d8b26a3b51d11a80ee0b158da31636268490b6b7141f9c0953934df47341f8
-  data.tar.gz: 31ee9aeae742be7e66c6f8c020957214a22af6edccf9d6131200b2c5b9a34182
+  metadata.gz: 88d970febf501ba9372769e1d9e133f7b2ba925f746cd0f548678d380f9febf9
+  data.tar.gz: '0902086c184c1e813ce6dab467f59c5b4b6a90414b248707267c7c3bfd7e46ff'
 SHA512:
-  metadata.gz: e15fe7d30af4bbc40b400b7aef5b51208d2478127bc4e23d1488ed80483be8a907711164b94a40655361286a6310d0f821614e469c1a3e2f536c56c9ca8cc290
-  data.tar.gz: 85858c2cf6fc6be5e607245c332f79aea2e26444f807a9937fba72fbb40b52c94df0ae410d3d0da9222b5c6e855ebfbb15721af0ee1f121c0d1cd8d5a83a649d
+  metadata.gz: ea31a1801ef196301ac6035e75fffbf9be1695f64406d2fc4321d467cd9db27874cdc6b26044ab61c17906d7ca0bb8928e901aa6fecbe9075fd57343bb3923cf
+  data.tar.gz: 6be76f8b62e4003dd09a8d1ac06ad7070de2077637a51158480dda664e70eecc46f3f1c1da5dcd1757d33abb636be1134894e34c7b5486247feec7aab6129b35

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    libexec (0.2.0)
+    libexec (0.2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -55,4 +55,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.3.26
+   2.4.1

data/lib/libexec/exec.rb

@@ -2,61 +2,71 @@
 
 module Libexec
   module Exec
-    def run(cmd, *argv, env: {}, mode: "r", **opts)
-      unless argv.empty?
-        cmd = [cmd]
-        argv.each do |arg|
-          # https://docs.ruby-lang.org/en/master/Kernel.html#method-i-class
-          if arg.instance_of?(Array)
-            cmd.concat(arg)
-          elsif arg.instance_of?(String)
-            cmd.push(arg)
-          end
-        end
-      end
+    # wrapper for Ruby IO.popen
+    # {https://docs.ruby-lang.org/en/master/IO.html#method-c-popen link} <br>
+    # cmd first grammar <br>
+    # conv argv by _ruby_style_cmd
+    #
+    # @return [nil]
+    def run(*argv, env: {}, mode: "r", **opts)
+      cmd = _ruby_style_cmd(argv)
 
-      # https://docs.ruby-lang.org/en/master/IO.html#method-c-popen
       IO.popen(env, cmd, mode, opts) do |pipe|
         print pipe.gets until pipe.eof?
       end
       nil
     end
 
-    def each_line(cmd, *argv, env: {}, mode: "r", **opts, &block)
-      unless argv.empty?
-        cmd = [cmd]
-        argv.each do |arg|
-          if arg.instance_of?(Array)
-            cmd.concat(arg)
-          elsif arg.instance_of?(String)
-            cmd.push(arg)
-          end
-        end
-      end
+    # Run code block in IO.popen <br>
+    # inspired from Ruby IO.each_line
+    # {https://docs.ruby-lang.org/en/master/IO.html#method-i-each_line link}
+    def each_line(*argv, env: {}, mode: "r", **opts, &block)
+      cmd = _ruby_style_cmd(argv)
 
-      # https://docs.ruby-lang.org/en/master/IO.html#method-i-each_line
       IO.popen(env, cmd, mode, opts) do |pipe|
         pipe.each_line(&block)
       end
     end
 
-    def by_ls_1(dir)
+    # wrapper for `ls -1` which will be often used
+    #
+    # @param  [Array] argv
+    # @return [Array] line.chomp
+    def by_ls_1(*argv, **opts)
       arr = []
-      each_line("ls -1 #{dir}") do |line|
+      argv.unshift(["ls", "-1"])
+      each_line(argv, opts: opts) do |line|
         arr.push line.chomp
       end
       arr
     end
 
-    def each_ls_1(dir, &block)
-      each_line("ls -1 #{dir}", &block)
+    # Operate each line result by yourself in `ls -1`
+    #
+    # @param [Array] argv
+    def each_ls_1(*argv, **opts, &block)
+      argv.unshift(["ls", "-1"])
+      each_line(argv, opts: opts, &block)
     end
 
-    def code(cmd, *opt, **args)
-      catch_error = !opt.empty? || args[:catch_error] || false
-      code = opt[0] || args[:code] || 1
+    # wrapper for Process.spawn
+    # {https://docs.ruby-lang.org/en/master/Process.html#method-c-last_status link}
+    #
+    # @return [Integer]
+    def code(*argv, **opts)
+      opt_catch_error = opts[:catch_error]
+      opt_code = opts[:code]
+
+      *args, last_arg = argv
 
-      # https://docs.ruby-lang.org/en/master/Process.html#method-c-last_status
+      is_integer = last_arg.instance_of?(Integer)
+      arg_catch_error = is_integer
+      arg_code = is_integer ? last_arg : false
+      
+      catch_error = arg_catch_error|| opt_catch_error || false
+      code = arg_code || opt_code || 1
+
+      cmd = is_integer ? _js_style_cmd(args) : _js_style_cmd(argv)
       Process.spawn(cmd)
       Process.wait
 
@@ -71,23 +81,56 @@ module Libexec
       127
     end
 
-    def output(cmd, *argv)
-      unless argv.empty?
+    # wrapper for Kernel.`command`
+    # {https://docs.ruby-lang.org/en/master/Kernel.html#method-i-60 link}
+    #
+    # @note Only recommend to use when get single line output
+    # @return [String] output.chomp
+    def output(*argv)
+      cmd = _js_style_cmd(argv)
+
+      output = `#{cmd}`
+      output.chomp
+    end
+
+    private
+
+    # cmd must be unix command String <br>
+    # no " ", not Array <br>
+    # not support cmd with opt like `ls -1`
+    #
+    # @param [Array] argv
+    # @return [String | Array]
+    #
+    # @since 0.2.1
+    def _ruby_style_cmd(argv)
+      cmd, *args = argv
+
+      args.empty? ? cmd : argv.flatten
+    end
+
+    # in JS style, all arg connect with " " <br>
+    # so cmd like `ls -1` is OK
+    #
+    # @param [Array] argv
+    # @return [String | Array]
+    #
+    # @since 0.2.1
+    def _js_style_cmd(argv)
+      cmd, *args = argv
+
+      unless args.empty?
         arr = [cmd]
-        argv.each do |arg|
+        args.each do |arg|
           if arg.instance_of?(Array)
-            arr.push("'#{arg.join(" ")}'")
-          elsif arg.instance_of?(String)
+            arr.push(%('#{arg.join(" ")}'))
+          else
             arr.push(arg)
           end
         end
-
         cmd = arr.join(" ")
       end
-
-      # https://docs.ruby-lang.org/en/master/Kernel.html#method-i-60
-      output = `#{cmd}`
-      output.chomp
+      cmd
     end
   end
 end

data/lib/libexec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Libexec
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/libexec.rb

@@ -4,8 +4,5 @@ require_relative "libexec/version"
 require_relative "libexec/exec"
 
 module Libexec
-  class Error < StandardError; end
-  # Your code goes here...
-
   extend Libexec::Exec
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libexec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - initdc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2022-12-30 00:00:00.000000000 Z
 dependencies: []
 description: Wrapper for ruby exec shell command.
 email: