cmds 0.2.4 → 0.2.5

data/lib/cmds/util/tokenize_value.rb

@@ -0,0 +1,154 @@
+require 'json'
+require 'pp'
+
+require 'nrser'
+
+require_relative "defaults"
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+
+
+class Cmds
+  TOKENIZE_OPT_KEYS = [
+    :array_mode,
+    :array_join_string,
+    :false_mode,
+    :flatten_array_values,
+    :hash_mode,
+    :hash_join_string,
+    :long_opt_separator,
+    :short_opt_separator,
+  ].freeze
+  
+  # turn an option name and value into an array of shell-escaped string
+  # token suitable for use in a command.
+  # 
+  # @param [String] name
+  #   string name (one or more characters).
+  # 
+  # @param [*] value
+  #   value of the option.
+  # 
+  # @param [Hash] **opts
+  # @option [Symbol] :array_mode (:multiple)
+  #   one of:
+  #   
+  #   1.  `:multiple` (default) provide one token for each value.
+  #       
+  #           expand_option 'blah', [1, 2, 3]
+  #           => ['--blah=1', '--blah=2', '--blah=3']
+  #   
+  #   2.  `:join` -- join values in one token.
+  #         
+  #           expand_option 'blah', [1, 2, 3], array_mode: :join
+  #           => ['--blah=1,2,3']
+  # 
+  # @option [String] :array_join_string (',')
+  #   string to join array values with when `:array_mode` is `:join`.
+  # 
+  # @return [Array<String>]
+  #   List of individual shell token strings.
+  # 
+  # @raise [ArgumentError]
+  #   If options are set to bad values.
+  # 
+  def self.tokenize_value value, **opts
+    opts = defaults opts, TOKENIZE_OPT_KEYS
+      
+    case value
+    when nil
+      # `nil` values produces no tokens
+      []
+      
+    when Array
+      # The PITA one...
+      # 
+      # May produce one or multiple tokens.
+      # 
+      
+      # Flatten the array value if option is set
+      value = value.flatten if opts[:flatten_array_values]
+      
+      case opts[:array_mode]
+      when :repeat
+        # Encode each entry as it's own token
+        # 
+        # [1, 2, 3] => ["1", "2", "3"]
+        # 
+        
+        # Pass entries back through for individual tokenization and flatten
+        # so we are sure to return a single-depth array
+        value.map { |entry| tokenize_value entry, **opts }.flatten
+        
+      when :join
+        # Encode all entries as one joined string token
+        # 
+        # [1, 2, 3] => ["1,2,3"]
+        # 
+        
+        [esc( value.join opts[:array_join_string] )]
+        
+      when :json
+        # Encode JSON dump as single token, single-quoted
+        # 
+        # [1, 2, 3] => ["'[1,2,3]'"]
+        
+        [single_quote( JSON.dump value )]
+        
+      else
+        # SOL
+        raise ArgumentError.new binding.erb <<-END
+          Bad `:array_mode` option:
+          
+              <%= opts[:array_mode].pretty_inspect %>
+          
+          Should be :join, :repeat or :json
+          
+        END
+        
+      end # case opts[:array_mode]
+    
+    when Hash
+      # Much the same as array
+      # 
+      # May produce one or multiple tokens.
+      # 
+      
+      case opts[:hash_mode]
+      when :join
+        # Join the key and value using the option and pass the resulting array
+        # back through to be handled as configured
+        tokenize_value \
+          value.map { |k, v| [k, v].join opts[:hash_join_string] },
+          **opts
+      
+      when :json
+        # Encode JSON dump as single token, single-quoted
+        # 
+        # [1, 2, 3] => [%{'{"a":1,"b":2,"c":3}'}]
+        
+        [single_quote( JSON.dump value )]
+        
+      else
+        # SOL
+        raise ArgumentError.new binding.erb <<-END
+          Bad `:hash_mode` option:
+          
+              <%= opts[:hash_mode].pretty_inspect %>
+          
+          Should be :join, or :json
+          
+        END
+      end
+    
+    else
+      # We let {Cmds.esc} handle it, and return that as a single token
+      [esc(value)]
+      
+    end
+  end
+end

data/lib/cmds/version.rb

@@ -1,3 +1,3 @@
 class Cmds
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/spec/cmds/env_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 describe "Cmds ENV vars" do
   r_echo_cmd = %{ruby -e "puts ENV['BLAH']"}
   
+  def r_echo key, **options
+    Cmds.new( %{ruby -e "puts ENV['#{ key }']"}, **options ).chomp!
+  end
+  
   it "sets basic (path-like) string ENV var" do
     cmd = Cmds.new r_echo_cmd, env: {BLAH: "x:y:z"}
     expect(cmd.chomp!).to eq "x:y:z"
@@ -23,4 +27,70 @@ describe "Cmds ENV vars" do
     }
     expect(cmd.chomp!).to eq "/usr/local/bin:/usr/bin:/bin"
   end
-end
+  
+  # Want to play around / test out what happens with ENV inheritance...
+  describe "ENV inheritance", :env_inheritance do
+    # Cmds::Debug.on
+    
+    context "random parent and child value, set in parent ENV" do
+      key = 'BLAH'
+      
+      before :each do
+        @rand = Random.rand.to_s
+        @parent_value = "parent_#{ @rand }"
+        @child_value = "child_#{ @rand }"
+        ENV[key] = @parent_value
+      end
+      
+      after :each do
+        ENV.delete key
+      end
+      
+      let :cmd_options do
+        {}
+      end
+      
+      subject do
+        r_echo key, cmd_options
+      end
+      
+      it "should have ENV[key] set to @parent_value" do
+        expect( ENV[key] ).to eq @parent_value
+      end
+      
+      describe "no env provided to cmd" do
+        it "has ENV[key] set to @parent_value in child" do
+          expect( r_echo key ).to eq @parent_value
+        end
+      end
+      
+      context_where cmd_options: {env: {}} do
+        it "should have ENV[key] set to @parent_value in child" do
+          is_expected.to eq @parent_value
+        end
+      end
+      
+      context_where(
+        cmd_options: {
+          unsetenv_others: true,
+        }
+      ) do
+        it "should have ENV[key] unset in child" do
+          is_expected.to eq ''
+        end
+      end
+      
+      context_where(
+        cmd_options: {
+          env: { key => wrap( :@child_value ) }
+        }
+      ) do
+        it "should have ENV[key] set to @child_value in child" do
+          expect(
+            r_echo key, env: {key => @child_value}
+          ).to eq @child_value
+        end
+      end
+    end
+  end
+end

data/spec/cmds/prepare_spec.rb

@@ -233,22 +233,73 @@ describe "Cmds.prepare" do
       it "outputs JSON-encoded options" do
         expect(
           Cmds.prepare 'blah <%= opts %>',
-            opts: { list: ['a', 'b', 'see'] } {
-            { array_mode: :json }
-          }
+            opts: { list: ['a', 'b', 'see'] } {{ array_mode: :json }}
         ).to eq %{blah --list='["a","b","see"]'}
       end
       
       it "handles single quotes in the string" do
         expect(
           Cmds.prepare 'blah <%= opts %>',
-            opts: { list: ["you're the best"] } {
-            { array_mode: :json }  
-          }
+            opts: { list: ["you're the best"] } {{ array_mode: :json }}
+        ).to eq %{blah --list='["you'"'"'re the best"]'}
+        
+        
+        expect(
+          Cmds.new(
+            'blah <%= opts %>',
+            kwds: {
+              opts: { list: ["you're the best"] }
+            },
+            array_mode: :json,
+          ).prepare
         ).to eq %{blah --list='["you'"'"'re the best"]'}
       end
     end
     
   end # "options with list values"
   
-end # ::sub
+  
+  describe %{space-separated "long" opts} do
+    
+    it %{should work when `long_opt_separator: ' '` passed to Cmds.new} do
+      expect(
+        Cmds.new(
+          'blah <%= opts %>',
+          kwds: {
+            opts: {
+              file: 'some/path.rb'
+            }
+          },
+          long_opt_separator: ' '
+        ).prepare
+      ).to eq %{blah --file some/path.rb}
+    end
+    
+  end # "space-separated long options"
+  
+  
+  describe "hash opt values" do
+    
+    it do
+      expect(
+        Cmds.prepare(
+          'docker build <%= opts %>',
+          opts: {
+            'build-arg' => {
+              'from_image' => 'blah:0.1.2',
+              'yarn_version' => '1.3.2',
+            }
+          }
+        ) {{
+          array_mode: :repeat,
+          long_opt_separator: ' ',
+          hash_join_string: '=',
+        }}
+      ).to eq %{docker build --build-arg from_image\\=blah:0.1.2 --build-arg yarn_version\\=1.3.2}
+    end
+    
+  end # "hash opt values"
+  
+  
+  
+end # ::prepare

data/spec/cmds/stream/output_spec.rb

@@ -0,0 +1,69 @@
+describe 'Cmds#stream' do
+  describe "streaming to an output file" do
+    describe "given a path that does not exist" do
+      let( :path ){ Cmds::ROOT / 'tmp' / 'stream_out.txt' }
+      
+      before :each do
+        FileUtils.rm( path ) if path.exist?
+      end
+      
+      context "using &io_block" do
+        context "and passing it the path opened for write" do
+          it "should write to the file" do
+            Cmds.stream "echo here" do |io|
+              io.out = path.open( 'w' )
+            end
+            
+            expect( path.read ).to eq "here\n"
+          end
+        end
+        
+        context "and passing it the path string" do
+          it "should create the file and write to it" do
+            Cmds.stream "echo there" do |io|
+              io.out = path.to_s
+            end
+            
+            expect( path.read ).to eq "there\n"
+          end
+        end
+        
+        context "and passing it the pathname" do
+          it "should create the file and write to it" do
+            Cmds.stream "echo everywhere" do |io|
+              io.out = path
+            end
+            
+            expect( path.read ).to eq "everywhere\n"
+          end
+        end
+      end # using &io_block
+      
+      
+      # Not sure how to deal with this re capture, so leave it out for now
+      # context "using constructor keyword" do
+      #   context "and passing it the path opened for write" do
+      #     it "should write to the file" do
+      #       Cmds.new( "echo here", out: path.open( 'w' ) ).stream
+      #       expect( path.read ).to eq "here\n"
+      #     end
+      #   end
+      # 
+      #   context "and passing it the path string" do
+      #     it "should create the file and write to it" do
+      #       Cmds.new( "echo there", out: path.to_s ).stream
+      #       expect( path.read ).to eq "there\n"
+      #     end
+      #   end
+      # 
+      #   context "and passing it the pathname" do
+      #     it "should create the file and write to it" do
+      #       Cmds.new( "echo everywhere", out: path ).stream
+      #       expect( path.read ).to eq "everywhere\n"
+      #     end
+      #   end
+      # end # using constructor keyword
+    end # "given a path that does not exist"
+  end # streaming to an output file
+  
+end # Cmds#stream

data/spec/cmds/util/shell_escape/quote_dance_spec.rb

@@ -0,0 +1,18 @@
+describe_spec_file(
+  spec_path: __FILE__,
+  module: Cmds,
+  method: :quote_dance,
+) do
+  
+  it_behaves_like "function",
+    mapping: {
+      ["you're", :single] => %{'you'"'"'re'},
+      ['such a "goober" dude', :double] => %{"such a "'"'"goober"'"'" dude"},
+      [%{hey "ho" let's go}, :double] => %{"hey "'"'"ho"'"'" let's go"}
+    },
+    
+    raising: {
+      ["blah", :not_there] => KeyError,
+    }
+  
+end # spec file

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@ require 'tempfile'
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'cmds'
 
+require 'nrser/rspex'
+
 ECHO_CMD = "./test/echo_cmd.rb"
 
 def echo_cmd_data result

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nrser
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.17
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.17
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,75 +87,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pastel
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 0.9.12
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
 description: 
 email:
 - neil@ztkae.com
@@ -184,8 +190,10 @@ files:
 - lib/cmds/util.rb
 - lib/cmds/util/defaults.rb
 - lib/cmds/util/params.rb
+- lib/cmds/util/shell_escape.rb
 - lib/cmds/util/tokenize_option.rb
 - lib/cmds/util/tokenize_options.rb
+- lib/cmds/util/tokenize_value.rb
 - lib/cmds/version.rb
 - scratch/erb.rb
 - scratch/popen3.rb
@@ -202,7 +210,9 @@ files:
 - spec/cmds/out_spec.rb
 - spec/cmds/prepare_spec.rb
 - spec/cmds/replace_shortcuts_spec.rb
+- spec/cmds/stream/output_spec.rb
 - spec/cmds/stream_spec.rb
+- spec/cmds/util/shell_escape/quote_dance_spec.rb
 - spec/cmds/util/tokenize_option_spec.rb
 - spec/cmds_spec.rb
 - spec/debug_helper.rb
@@ -249,7 +259,9 @@ test_files:
 - spec/cmds/out_spec.rb
 - spec/cmds/prepare_spec.rb
 - spec/cmds/replace_shortcuts_spec.rb
+- spec/cmds/stream/output_spec.rb
 - spec/cmds/stream_spec.rb
+- spec/cmds/util/shell_escape/quote_dance_spec.rb
 - spec/cmds/util/tokenize_option_spec.rb
 - spec/cmds_spec.rb
 - spec/debug_helper.rb