satorix 1.5.6 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e9a786e4a891323bcccf116692ed7dc8b10d7d377b643531a55d9e9d3f8bec9
-  data.tar.gz: 5cd477477940f49e909ae1e07b70caa0c904cf21f4fbb29ada39d47a9e22d5e2
+  metadata.gz: 274dbd65366f3a703d2a57b81524f4aa9aa9522b0caa2f2b8158758b20c1861c
+  data.tar.gz: 3fb98c60b4e33c30d053d23c6833d39e809c6d9da4785475694b554e974a9699
 SHA512:
-  metadata.gz: 2d06b69fa7cb60f227721624afa71c0dba58c24e37f4c940044d7a93a150bbc32d21bc093da004225b9969d33b999509de74612696be6fb4dad23749e08e71e1
-  data.tar.gz: 1901acc5407af74742f4eb08603ae53e3d67864b409df38ba2e5ac02e78768b51e5cc983f718829d114b10045d3261ef8cff5b76c8c106a5df421b799ce56a6a
+  metadata.gz: 77f3d4a3a876d26f1d335936e4d613dad6280cbff9367d31672a2b56df16086c074ba066a1b11760a802d9a357491e1275d81bb09473726716dffc47f1798de8
+  data.tar.gz: 22aefe7ba2cb3a806b44635e8554762a912283a66cb7f6628a16937e1e3e166ce7437ae38e13471722c2e5cbc196d043d6f1c33886990a5771ac974f0c6c4ada

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    satorix (1.5.6)
+    satorix (1.6.0)
       airbrake-ruby
       bundler (~> 1.13)
       rake

data/lib/satorix.rb

@@ -5,12 +5,10 @@ require 'etc'
 
 module Satorix
 
-
   module Shared
     autoload :Console, 'satorix/shared/console'
   end
 
-
   module CI
 
     module Deploy
@@ -51,10 +49,8 @@ module Satorix
 
   end
 
-
   include Satorix::Shared::Console
 
-
   extend self
 
 
@@ -89,7 +85,7 @@ module Satorix
 
   def add_user(username)
     unless user_exists?(username)
-      run_command ['useradd', '--user-group', '--comment', "'#{ username } user'", '--shell', '/bin/bash', '--home', app_dir, username], quiet: true
+      run_command(['useradd', '--user-group', '--comment', "'#{ username } user'", '--shell', '/bin/bash', '--home', app_dir, username], quiet: true)
     end
   end
 
@@ -342,5 +338,4 @@ module Satorix
     Dir[File.join(build_dir, '*.gemspec')].any?
   end
 
-
 end

data/lib/satorix/CI/deploy/flynn.rb

@@ -3,7 +3,6 @@ module Satorix
     module Deploy
       module Flynn
 
-
         include Satorix
         include Satorix::Shared::Console
 
@@ -19,7 +18,6 @@ module Satorix
         require_relative 'flynn/scale'
         include Scale
 
-
         extend self
 
 
@@ -43,12 +41,12 @@ module Satorix
 
 
         def add_cluster
-          run_command "flynn cluster add --force --default --tls-pin=#{ tls_pin } #{ cluster_name } #{ domain_for_cluster } #{ key }", filtered_text: [tls_pin, key]
+          run_command(['flynn', 'cluster', 'add', '--force', '--default', "--tls-pin=#{ tls_pin }", cluster_name, domain_for_cluster, key], filtered_text: [tls_pin, key])
         end
 
 
         def add_remote
-          run_command "flynn -a #{ project_name } remote add #{ cluster_name } -y"
+          run_command(['flynn', '-a', project_name, 'remote', 'add', cluster_name, '-y'])
         end
 
 
@@ -58,21 +56,21 @@ module Satorix
 
 
         def configure_inactive_slug_releases
-          run_command 'flynn meta set gc.max_inactive_slug_releases=2'
+          run_command(%w[flynn meta set gc.max_inactive_slug_releases=2])
         end
 
 
         def create_project
           if project_exists?
-            log "Skipping - Flynn project '#{ project_name }' already exists."
+            log("Skipping - Flynn project '#{ project_name }' already exists.")
           else
-            run_command "flynn create --remote=#{ cluster_name } -y #{ project_name }"
+            run_command(['flynn', 'create', "--remote=#{ cluster_name }", '-y', 'project_name'])
           end
         end
 
 
         def deploy
-          run_command "git push #{ cluster_name } HEAD:refs/heads/master"
+          run_command(['git', 'push', cluster_name, 'HEAD:refs/heads/master'])
         end
 
 
@@ -102,7 +100,7 @@ module Satorix
 
 
         def project_exists?
-          `flynn apps`.split(/\R/).map { |a| a.split.last }.include? project_name
+          run_command(%w[flynn apps], quiet: true).split(/\R/).map { |a| a.split.last }.include? project_name
         end
 
 
@@ -115,8 +113,8 @@ module Satorix
           if desired_resource_provider_names.nil? || desired_resource_provider_names.empty?
             log 'Skipping migrations, no database has been defined. Please see the resources section of this log for more information.'
           else
-            run_command('flynn run --enable-log bundle exec rake db:migrate') if rails_app?
-            run_command('flynn run --enable-log python public/manage.py migrate') if django_app?
+            run_command(%w[flynn run --enable-log bundle exec rake db:migrate]) if rails_app?
+            run_command(%w[flynn run --enable-log python public/manage.py migrate]) if django_app?
           end
         end
 
@@ -125,7 +123,6 @@ module Satorix
           ENV["FLYNN_#{ current_branch }_TLSPIN"]
         end
 
-
       end
     end
   end

data/lib/satorix/CI/deploy/flynn/environment_variables.rb

@@ -6,7 +6,6 @@ module Satorix
       module Flynn
         module EnvironmentVariables
 
-
           def adjust_env_vars
             ensure_required_env_vars_are_defined unless ENV["SATORIX_#{ current_branch }_ENFORCE_ENV_VAR_DEFINITION"] == 'false'
             env_unset
@@ -15,7 +14,7 @@ module Satorix
 
 
           def aeev_key_exists?
-            !(run_command('flynn env', quiet: true) =~ /#{ exported_aeevs_key }=/mi).nil?
+            !(run_command(%w[flynn env], quiet: true) =~ /#{ exported_aeevs_key }=/mi).nil?
           end
 
 
@@ -35,7 +34,7 @@ module Satorix
 
 
           def current_flynn_keys
-            aeev_key_exists? ? run_command("flynn env get #{ exported_aeevs_key }", quiet: true).split : []
+            aeev_key_exists? ? run_command(['flynn', 'env', 'get', exported_aeevs_key], quiet: true).split : []
           end
 
 
@@ -87,17 +86,17 @@ module Satorix
             if env_vars_to_unset.empty?
               log 'No existing environment variables to unset.'
             else
-              run_command "flynn env unset #{ env_vars_to_unset.join(' ') }"
+              run_command(['flynn', 'env', 'unset', env_vars_to_unset])
             end
           end
 
 
           def env_vars
             @_env_vars ||= begin
-              {}.tap do |vars|
-                current_flynn_keys.each { |key| vars[key] = run_command("flynn env get #{ key }", quiet: true).chomp }
-              end
-            end
+                             {}.tap do |vars|
+                               current_flynn_keys.each { |key| vars[key] = run_command(['flynn', 'env', 'get', key], quiet: true).chomp }
+                             end
+                           end
           end
 
 
@@ -115,7 +114,6 @@ module Satorix
             'AEEV_KEYS'
           end
 
-
         end
       end
     end

data/lib/satorix/CI/deploy/flynn/resources.rb

@@ -4,12 +4,11 @@ module Satorix
       module Flynn
         module Resources
 
-
           def add_resources
             if resources_to_add.empty?
               log 'No resources to add.'
             else
-              resources_to_add.each { |resource| run_command "flynn resource add #{ resource }" }
+              resources_to_add.each { |resource| run_command(['flynn', 'resource', 'add', resource]) }
             end
           end
 
@@ -47,7 +46,7 @@ module Satorix
 
 
           def resource
-            run_command('flynn resource', quiet: true).chomp
+            run_command(%w[flynn resource], quiet: true).chomp
           end
 
 
@@ -71,7 +70,6 @@ module Satorix
             remove_resources
           end
 
-
         end
       end
     end

data/lib/satorix/CI/deploy/flynn/routes.rb

@@ -4,7 +4,6 @@ module Satorix
       module Flynn
         module Routes
 
-
           def find_or_create_route(domain)
             route_ids = route_ids(domain)
             if route_ids.empty?
@@ -134,22 +133,22 @@ module Satorix
 
 
           def fc_route
-            run_command("flynn -a #{ project_name } route", quiet: true).chomp
+            run_command(['flynn', '-a', project_name, 'route'], quiet: true).chomp
           end
 
 
           def fc_route_add(domain)
-            run_command("flynn route add http #{ domain } --sticky").chomp
+            run_command(['flynn', 'route', 'add', 'http', domain, '--sticky']).chomp
           end
 
 
           def fc_route_remove(route_id)
-            run_command "flynn route remove #{ route_id }"
+            run_command(['flynn', 'route', 'remove', route_id])
           end
 
 
           def fc_route_update(route_id)
-            run_command "flynn route update #{ route_id } --tls-cert=crt --tls-key=key --sticky", quiet: true
+            run_command(['flynn', 'route', 'update', route_id, '--tls-cert=crt', '--tls-key=key', '--sticky'], quiet: true)
           end
 
 

data/lib/satorix/CI/deploy/flynn/scale.rb

@@ -4,7 +4,6 @@ module Satorix
       module Flynn
         module Scale
 
-
           def adjust_scale
             cached_scale_options_to_set = scale_options_to_set
             log "No scale specified in #{ defined_scale_key }. Displaying current scale:" if cached_scale_options_to_set.empty?
@@ -28,7 +27,9 @@ module Satorix
 
 
           def fc_scale(scale_options_to_set = nil)
-            run_command "flynn scale#{ " #{ scale_options_to_set }" unless scale_options_to_set.nil? || scale_options_to_set.empty? }".chomp
+            command = %w[flynn scale].concat(scale_options_to_set)
+
+            run_command(command)
           end
 
 
@@ -36,7 +37,7 @@ module Satorix
             [].tap do |scale|
               defined_scale.each { |job, workers| scale << "#{ job }=#{ workers }" }
               (current_scale.keys - defined_scale.keys).each { |job| scale << "#{ job }=0" } unless defined_scale.empty?
-            end.join(' ')
+            end
           end
 
 
@@ -44,7 +45,6 @@ module Satorix
             {}.tap { |jobs| scale_string.split.map { |x| x.partition('=') }.each { |x| jobs[x.first.to_sym] = x.last } }
           end
 
-
         end
       end
     end

data/lib/satorix/CI/shared/buildpack_manager.rb

@@ -2,19 +2,15 @@ module Satorix
   module CI
     module Shared
 
-
       # This code was inspired by:
       # herokuish - https://github.com/gliderlabs/herokuish
       # flynn - https://github.com/flynn/flynn/blob/master/slugbuilder/builder/build.sh
       module BuildpackManager
 
-
         require 'fileutils'
 
-
         include Satorix::Shared::Console
 
-
         extend self
 
 
@@ -111,7 +107,7 @@ module Satorix
 
 
         def lsb_release
-          run_command('lsb_release --release --short', quiet: true).chomp
+          run_command(%w[lsb_release --release --short], quiet: true).chomp
         end
 
 
@@ -139,7 +135,7 @@ module Satorix
           profile_locations.each do |profile_location|
             Dir.glob(profile_location) do |shell_file|
               # Uncomment below to debug profile loading
-              # run_command "cat #{ shell_file }"
+              # run_command(['cat', shell_file])
               source_env_from shell_file
             end
           end
@@ -211,7 +207,6 @@ module Satorix
           end
         end
 
-
       end
     end
   end

data/lib/satorix/CI/shared/buildpack_manager/buildpack.rb

@@ -3,17 +3,13 @@ module Satorix
     module Shared
       module BuildpackManager
 
-
         class Buildpack
 
-
           require 'fileutils'
           require 'uri'
 
-
           include Satorix::Shared::Console
 
-
           attr_accessor :commit_sha_short,
                         :url
 
@@ -30,10 +26,10 @@ module Satorix
 
           def compile
             log_bench "Building application using the #{ name } buildpack..." do
-              run_command [compile_binary_path,
+              run_command([compile_binary_path,
                            Satorix.build_dir,
                            Satorix.paths[:cache],
-                           Satorix.paths[:env]]
+                           Satorix.paths[:env]])
             end
           end
 
@@ -98,14 +94,14 @@ module Satorix
 
 
           def checkout_specific_version
-            run_command ['git', 'clone', '--quiet', '--no-checkout', url, path], quiet: true
-            Dir.chdir(path) { run_command ['git', 'checkout', '--quiet', commit_sha_short], quiet: true }
-            Dir.chdir(path) { run_command ['git', 'submodule', 'update', '--init', '--recursive'], quiet: true }
+            run_command(['git', 'clone', '--quiet', '--no-checkout', url, path], quiet: true)
+            Dir.chdir(path) { run_command(['git', 'checkout', '--quiet', commit_sha_short], quiet: true) }
+            Dir.chdir(path) { run_command(%w[git submodule update --init --recursive], quiet: true) }
           end
 
 
           def checkout_newest_version
-            run_command ['git', 'clone', '--quiet', '--recursive', '--depth', '1', url, path], quiet: true
+            run_command(['git', 'clone', '--quiet', '--recursive', '--depth', '1', url, path], quiet: true)
           end
 
 
@@ -149,10 +145,8 @@ module Satorix
             satorix_distrib_sha_version || git_sha_short
           end
 
-
         end
 
-
       end
     end
   end

data/lib/satorix/CI/shared/ruby/gem_manager.rb

@@ -38,7 +38,7 @@ module Satorix
           def restore_missing_gems(quiet = true)
             # The buildpack incorrectly removes gems that are included using add_development_dependency.
             # These gems must remain available for testing.
-            run_command('bundle install --with development', quiet: quiet)
+            run_command(%w[bundle install --with development], quiet: quiet)
           end
 
 
@@ -64,12 +64,11 @@ module Satorix
 
 
           def regenerate_gemfile_lock(quiet = true)
-            run_command('bundle config --local frozen false', quiet: quiet)
-            run_command('bundle install', quiet: quiet)
+            run_command(%w[bundle config --local frozen false], quiet: quiet)
+            run_command(%w[bundle install], quiet: quiet)
             log "\n\n#{ File.read(File.join(Satorix.app_dir, 'Gemfile.lock')) }" unless quiet
           end
 
-
         end
       end
     end

data/lib/satorix/CI/shared/yarn_manager.rb

@@ -4,20 +4,17 @@ module Satorix
 
       module YarnManager
 
-
         include Satorix::Shared::Console
 
-
         extend self
 
 
         def go
-          log_bench('Installing yarn dependencies...') { run_command 'yarn install' }
+          log_bench('Installing yarn dependencies...') { run_command(%w[yarn install]) }
         end
 
 
-        private ########################################################################################################
-
+        private
 
       end
     end

data/lib/satorix/CI/test/python/django_test.rb

@@ -4,32 +4,29 @@ module Satorix
       module Python
         module DjangoTest
 
-
           include Satorix::Shared::Console
 
-
           extend self
 
 
           def go
-            log_bench('Displaying current Python version...') { run_command 'python --version' }
+            log_bench('Displaying current Python version...') { run_command(%w[python --version]) }
             log_bench('Running tests...') { run_tests }
           end
 
 
           def run_tests
-            run_command "#{ manage } collectstatic"
-            run_command "#{ manage } test public"
+            run_command([manage, 'collectstatic'])
+            run_command([manage, 'test', 'public'])
           end
 
 
-          private ######################################################################################################
+          private
 
 
-          def manage
-            File.join(Satorix.app_dir, 'public', 'manage.py')
-          end
-
+            def manage
+              File.join(Satorix.app_dir, 'public', 'manage.py')
+            end
 
         end
       end

data/lib/satorix/CI/test/python/safety.rb

@@ -4,25 +4,22 @@ module Satorix
       module Python
         module Safety
 
-
           include Satorix::Shared::Console
 
-
           extend self
 
 
           def go
-            log_bench('Displaying current Python version...') { run_command 'python --version' }
-            log_bench('Installing Safety...') {run_command 'pip install safety'}
+            log_bench('Displaying current Python version...') { run_command(%w[python --version]) }
+            log_bench('Installing Safety...') { run_command(%w[pip install safety]) }
             log_bench('Auditing requirements.txt...') { run_scan }
           end
 
 
           def run_scan
-            run_command "safety check -r requirements.txt"
+            run_command(%w[safety check -r requirements.txt])
           end
 
-
         end
       end
     end

data/lib/satorix/CI/test/ruby/brakeman.rb

@@ -4,30 +4,27 @@ module Satorix
       module Ruby
         module Brakeman
 
-
           include Satorix::Shared::Console
 
-
           extend self
 
 
           def go
-            log_bench('Displaying current Ruby version...') { run_command 'ruby -v' }
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
             log_bench('Installing Brakeman...') { install_gem }
             log_bench('Running Brakeman scan...') { run_scan }
           end
 
 
           def install_gem
-            run_command "gem install brakeman --no-document --bindir #{ Satorix.bin_dir }"
+            run_command(['gem', 'install', 'brakeman', '--no-document', '--bindir', Satorix.bin_dir])
           end
 
 
           def run_scan
-            run_command "brakeman -z --table-width 1200 --exit-on-error --path #{ Satorix.app_dir }"
+            run_command(['brakeman', '-z', '--table-width', '1200', '--exit-on-error', '--path', Satorix.app_dir])
           end
 
-
         end
       end
     end

data/lib/satorix/CI/test/ruby/bundler_audit.rb

@@ -4,30 +4,27 @@ module Satorix
       module Ruby
         module BundlerAudit
 
-
           include Satorix::Shared::Console
 
-
           extend self
 
 
           def go
-            log_bench('Displaying current Ruby version...') { run_command 'ruby -v' }
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
             log_bench('Installing bundler-audit...') { install_gem }
             log_bench('Auditing Gemfile.lock...') { run_scan }
           end
 
 
           def install_gem
-            run_command "gem install bundler-audit --no-document --bindir #{ Satorix.bin_dir }"
+            run_command(['gem', 'install', 'bundler-audit', '--no-document', '--bindir', Satorix.bin_dir])
           end
 
 
           def run_scan
-            run_command 'bundle-audit check --update'
+            run_command(%w[bundle-audit check --update])
           end
 
-
         end
       end
     end

data/lib/satorix/CI/test/ruby/cucumber.rb

@@ -4,24 +4,21 @@ module Satorix
       module Ruby
         module Cucumber
 
-
           include Satorix::Shared::Console
 
-
           extend self
 
 
           def go
-            log_bench('Displaying current Ruby version...') { run_command 'ruby -v' }
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
             log_bench('Running Cucumber...') { run_cucumber }
           end
 
 
           def run_cucumber
-            run_command 'bundle exec cucumber'
+            run_command(%w[bundle exec cucumber])
           end
 
-
         end
       end
     end

data/lib/satorix/CI/test/ruby/rails_test.rb

@@ -4,24 +4,21 @@ module Satorix
       module Ruby
         module RailsTest
 
-
           include Satorix::Shared::Console
 
-
           extend self
 
 
           def go
-            log_bench('Displaying current Ruby version...') { run_command 'ruby -v' }
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
             log_bench('Running Rails test...') { run_scan }
           end
 
 
           def run_scan
-            run_command 'rails test'
+            run_command(%w[rails test])
           end
 
-
         end
       end
     end

data/lib/satorix/CI/test/ruby/rspec.rb

@@ -4,24 +4,21 @@ module Satorix
       module Ruby
         module Rspec
 
-
           include Satorix::Shared::Console
 
-
           extend self
 
 
           def go
-            log_bench('Displaying current Ruby version...') { run_command 'ruby -v' }
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
             log_bench('Running specs...') { run_specs }
           end
 
 
           def run_specs
-            run_command 'rspec spec'
+            run_command(%w[rspec spec])
           end
 
-
         end
       end
     end

data/lib/satorix/CI/test/ruby/rubocop.rb

@@ -4,15 +4,13 @@ module Satorix
       module Ruby
         module Rubocop
 
-
           include Satorix::Shared::Console
 
-
           extend self
 
 
           def go
-            log_bench('Displaying current Ruby version...') { run_command 'ruby -v' }
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
             log_bench('Installing Rubocop...') { install_gems }
             log_bench('Configuring Rubocop...') { create_rubocop_config }
             log_bench('Running Rubocop inspection...') { run_scan }
@@ -20,9 +18,9 @@ module Satorix
 
 
           def install_gems
-            run_command "gem install rubocop --no-document --bindir #{ Satorix.bin_dir }"
-            run_command "gem install rubocop-performance --no-document --bindir #{ Satorix.bin_dir }"
-            run_command "gem install rubocop-rails_config --no-document --bindir #{ Satorix.bin_dir }" if Satorix.rails_app?
+            run_command(['gem', 'install', 'rubocop', '--no-document', '--bindir', Satorix.bin_dir])
+            run_command(['gem', 'install', 'rubocop-performance', '--no-document', '--bindir', Satorix.bin_dir])
+            run_command(['gem', 'install', 'rubocop-rails_config', '--no-document', '--bindir', Satorix.bin_dir]) if Satorix.rails_app?
           end
 
 
@@ -39,57 +37,59 @@ module Satorix
 
 
           def run_scan
-            run_command "rubocop --require rubocop-performance #{ '--require rubocop-rails ' if Satorix.rails_app? }--display-cop-names --extra-details --display-style-guide --parallel"
-          end
+            command = %w[rubocop --require rubocop-performance --display-cop-names --extra-details --display-style-guide --parallel]
+            command.concat(%w[--require rubocop-rails]) if Satorix.rails_app?
 
+            run_command(command)
+          end
 
-          private ######################################################################################################
 
+          private
 
-          def rubocop_config_file
-            File.join(Satorix.app_dir, '.rubocop.yml')
-          end
 
+            def rubocop_config_file
+              File.join(Satorix.app_dir, '.rubocop.yml')
+            end
 
-          def save_rubocop_config(config)
-            File.open(rubocop_config_file, 'w') { |f| f.write(config) }
-          end
 
+            def save_rubocop_config(config)
+              File.open(rubocop_config_file, 'w') { |f| f.write(config) }
+            end
 
-          def config_exist?
-            File.exist? rubocop_config_file
-          end
 
+            def config_exist?
+              File.exist? rubocop_config_file
+            end
 
-          def ruby_version
-            version = run_command 'bundle platform --ruby', quiet: true
-            version.match(/\d+\.\d+\.\d+/)[0]
-          end
 
+            def ruby_version
+              version = run_command(%w[bundle platform --ruby], quiet: true)
+              version.match(/\d+\.\d+\.\d+/)[0]
+            end
 
-          def config_content_default
-            <<~CONTENT
-              AllCops:
-                TargetRubyVersion: #{ ruby_version }
-                Exclude:
-                  - '**/tmp/**/*'
-                  - '**/templates/**/*'
-                  - '**/vendor/**/*'
-            CONTENT
-          end
 
+            def config_content_default
+              <<~CONTENT
+                AllCops:
+                  TargetRubyVersion: #{ ruby_version }
+                  Exclude:
+                    - '**/tmp/**/*'
+                    - '**/templates/**/*'
+                    - '**/vendor/**/*'
+              CONTENT
+            end
 
-          def config_content_rails
-            <<~CONTENT
-              inherit_gem:
-                rubocop-rails_config:
-                  - config/rails.yml
 
-              AllCops:
-                TargetRubyVersion: #{ ruby_version }
-            CONTENT
-          end
+            def config_content_rails
+              <<~CONTENT
+                inherit_gem:
+                  rubocop-rails_config:
+                    - config/rails.yml
 
+                AllCops:
+                  TargetRubyVersion: #{ ruby_version }
+              CONTENT
+            end
 
         end
       end

data/lib/satorix/shared/console.rb

@@ -2,15 +2,18 @@ module Satorix
   module Shared
     module Console
 
-
       require 'benchmark'
       require 'English' # http://ruby-doc.org/stdlib-2.0.0/libdoc/English/rdoc/English.html
       require 'shellwords'
 
-
       extend self
 
 
+      def colorize(text, color = nil)
+        "\033[#{ colors[color] }m#{ text }\033[0m"
+      end
+
+
       def colors
         Hash.new(39).merge(red: '0;31', light_red: '1;31',
                            green: '0;32', light_green: '1;32',
@@ -22,8 +25,15 @@ module Satorix
       end
 
 
-      def colorize(text, color = nil)
-        "\033[#{ colors[color] }m#{ text }\033[0m"
+      def humanize_time(seconds)
+        return 'less than 1 second' if seconds < 1
+        [[60, :second], [60, :minute], [24, :hour], [1000, :day]].map do |count, name|
+          if seconds > 0
+            seconds, n = seconds.divmod(count)
+            n = n.to_i
+            "#{ n } #{ name }#{ 's' if n > 1 }" if n > 0
+          end
+        end.compact.reverse.join(' ')
       end
 
 
@@ -66,28 +76,31 @@ module Satorix
       end
 
 
-      def humanize_time(seconds)
-        return 'less than 1 second' if seconds < 1
-        [[60, :second], [60, :minute], [24, :hour], [1000, :day]].map do |count, name|
-          if seconds > 0
-            seconds, n = seconds.divmod(count)
-            n = n.to_i
-            "#{ n } #{ name }#{ 's' if n > 1 }" if n > 0
-          end
-        end.compact.reverse.join(' ')
-      end
-
-
-      # This method is used *EVERYWHERE*.
-      # Seemingly small changes can have far-ranging and extreme consequences.
-      # Modify only with extreme caution.
+      # The preferred way to use this method is by passing an array containing the command.
+      # This will ensure that items are properly escaped.
+      # It is also possible to use nested arrays. See tests for example use cases.
+      #
+      # If you want to see how your string command translates into an arry, you can use shellsplit method.
       #
-      # Note: Many applications (like echo and the Flynn CLI) append a newline to their output.
-      #       If you are using the command result, it may be desirable to chomp the trailing
-      #       newline. It is left to the implementing call to handle this, as it proved
-      #       cumbersome to handle in this method in a way that worked perfectly in all cases.
-      def run_command(command, filtered_text: [], quiet: false)
-        command = command.shelljoin if command.is_a?(Array)
+      # For example:
+      # 'ruby -v'.shellsplit
+      #  => ["ruby", "-v"]
+      #
+      # If, for some reason, you need to supply a string that is already escaped or should not be escaped, it is
+      # possible to supply a string argument instead of an array. If you do this, you will need to supply
+      # an additional parameter of string_verified_safe, to ensure that the operation is deliberate.
+      def run_command(command, filtered_text: [], quiet: false, string_verified_safe: false)
+        # This method is used *EVERYWHERE*.
+        # Seemingly small changes can have far-ranging and extreme consequences.
+        # Modify only with extreme caution.
+        #
+        # Note: Many applications (like echo and the Flynn CLI) append a newline to their output.
+        #       If you are using the command result, it may be desirable to chomp the trailing
+        #       newline. It is left to the implementing call to handle this, as it proved
+        #       cumbersome to handle in this method in a way that worked perfectly in all cases.
+        raise('Potentially unsafe or problematic command. Please refer to the method documentation for more information.') if command.is_a?(String) && !string_verified_safe
+
+        command = normalized_command(command)
         logged_command = logged_command(command, filtered_text)
         log_command(logged_command) unless quiet
 
@@ -114,43 +127,53 @@ module Satorix
       end
 
 
-      private ##########################################################################################################
+      private
 
 
-      def logged_command(command, filtered_text)
-        filtered_text = [filtered_text].flatten.delete_if { |text| text.nil? || text.strip.empty? }
-        command.gsub(Regexp.union(filtered_text), '[MASKED]')
-      end
+        def bash(command)
+          ['bash -c', escaped_command(command), '2>&1'].join(' ')
+        end
 
 
-      def bash(command)
-        "bash -c #{ command.shellescape } 2>&1"
-      end
+        def logged_command(command, filtered_text)
+          filtered_text = [filtered_text].flatten.delete_if { |text| text.nil? || text.strip.empty? }
+          unescaped_command = command.shellsplit.join(' ')
+          unescaped_command.gsub(Regexp.union(filtered_text.sort_by(&:length).reverse), '[MASKED]')
+        end
+
+
+        def escaped_command(command)
+          command.shellescape
+        end
+
+
+        def normalized_command(command)
+          command.is_a?(Array) ? command.flatten.shelljoin : command
+        end
+
+
+        def handle_run_command_error(logged_command, quiet)
+          error_message = "\nAn error has occurred while running the following command:\n#{ logged_command }\n"
+          quiet ? abort : log_error_and_abort(error_message)
+        end
 
 
       # http://stackoverflow.com/questions/1197224/source-shell-script-into-environment-within-a-ruby-script
       # TODO : reduce / consolidate?
       # Read in the bash environment, after an optional command. Returns Array of key/value pairs.
-      def bash_env(cmd = nil)
-        env_cmd = bash("#{ cmd + ';' if cmd } printenv")
-        env = `#{ env_cmd }`
-        env.split(/\n/).map { |l| l.split(/=/, 2) }
-      end
+        def bash_env(cmd = nil)
+          env_cmd = bash("#{ cmd + ';' if cmd } printenv")
+          env = `#{ env_cmd }`
+          env.split(/\n/).map { |l| l.split(/=/, 2) }
+        end
 
 
       # http://stackoverflow.com/questions/1197224/source-shell-script-into-environment-within-a-ruby-script
       # TODO : reduce / consolidate?
       # Source a given file, and compare environment before and after. Returns Hash of any keys that have changed.
-      def bash_source(file)
-        Hash[bash_env("source #{ File.realpath file }") - bash_env]
-      end
-
-
-      def handle_run_command_error(logged_command, quiet)
-        error_message = "\nAn error has occurred while running the following command:\n#{ logged_command }\n"
-        quiet ? abort : log_error_and_abort(error_message)
-      end
-
+        def bash_source(file)
+          Hash[bash_env("source #{ File.realpath file }") - bash_env]
+        end
 
     end
   end

data/lib/satorix/version.rb

@@ -1,3 +1,3 @@
 module Satorix
-  VERSION = '1.5.6'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/satorix/CI/deploy/ie_gem_server.rb

@@ -3,13 +3,10 @@ module Satorix
     module Deploy
       module IeGemServer
 
-
         require 'fileutils'
 
-
         include Satorix::Shared::Console
 
-
         extend self
 
 
@@ -22,7 +19,7 @@ module Satorix
 
 
         def build_gem
-          run_command 'rake build'
+          run_command(%w[rake build])
         end
 
 
@@ -32,7 +29,7 @@ module Satorix
 
 
         def gem_build_directory
-          File.join Satorix.app_dir, 'pkg'
+          File.join(Satorix.app_dir, 'pkg')
         end
 
 
@@ -42,37 +39,36 @@ module Satorix
 
 
         def install_geminabox_gem
-          run_command "gem install geminabox --source https://gems.iexposure.com --no-document --bindir #{ Satorix.bin_dir }"
+          run_command(['gem', 'install', 'geminabox', '--source', 'https://gems.iexposure.com', '--no-document', '--bindir', Satorix.bin_dir])
         end
 
 
         def prepare_gem_build_directory
-          run_command "rm -rf #{ gem_build_directory }", quiet: true
+          run_command(['rm', '-rf', gem_build_directory], quiet: true)
           FileUtils.mkdir_p gem_build_directory
         end
 
 
         def publish_gem(gem)
-          run_command "gem inabox #{ gem } --host #{ ie_gem_server_host }",
-                      filtered_text: [ie_gem_server_user_name, ie_gem_server_password]
+          run_command(['gem', 'inabox', gem, '--host', ie_gem_server_host],
+                      filtered_text: [ie_gem_server_user_name, ie_gem_server_password])
         rescue RuntimeError
           # To prevent the display of an ugly stacktrace.
           abort "\nGem was not published!"
         end
 
 
-        private ########################################################################################################
+        private
 
 
-        def ie_gem_server_password
-          ENV['IE_GEM_SERVER_PASSWORD']
-        end
-
+          def ie_gem_server_password
+            ENV['IE_GEM_SERVER_PASSWORD']
+          end
 
-        def ie_gem_server_user_name
-          ENV['IE_GEM_SERVER_USER_NAME']
-        end
 
+          def ie_gem_server_user_name
+            ENV['IE_GEM_SERVER_USER_NAME']
+          end
 
       end
     end

data/satorix/CI/deploy/rubygems.rb

@@ -3,13 +3,10 @@ module Satorix
     module Deploy
       module Rubygems
 
-
         require 'fileutils'
 
-
         include Satorix::Shared::Console
 
-
         extend self
 
 
@@ -21,59 +18,58 @@ module Satorix
         end
 
 
-        private ########################################################################################################
+        private
 
 
-        def build_gem
-          Dir.chdir(Satorix.app_dir) do
-            run_command 'bundle exec rake build'
+          def build_gem
+            Dir.chdir(Satorix.app_dir) do
+              run_command(%w[bundle exec rake build])
+            end
           end
-        end
-
 
-        def built_gems
-          Dir.glob(File.join(gem_build_directory, '*.gem')).select { |e| File.file? e }
-        end
 
+          def built_gems
+            Dir.glob(File.join(gem_build_directory, '*.gem')).select { |e| File.file? e }
+          end
 
-        def gem_build_directory
-          File.join Satorix.app_dir, 'pkg'
-        end
 
+          def gem_build_directory
+            File.join(Satorix.app_dir, 'pkg')
+          end
 
-        def generate_rubygems_configuration_file
-          path = File.join(Dir.home, '.gem')
-          FileUtils.mkdir_p(path) unless File.exist?(path)
 
-          file = File.join(path, 'credentials')
-          File.open(file, 'w') { |f| f.write rubygems_configuration_file_contents }
-          FileUtils.chmod 0600, file
-        end
+          def generate_rubygems_configuration_file
+            path = File.join(Dir.home, '.gem')
+            FileUtils.mkdir_p(path) unless File.exist?(path)
 
+            file = File.join(path, 'credentials')
+            File.open(file, 'w') { |f| f.write rubygems_configuration_file_contents }
+            FileUtils.chmod 0600, file
+          end
 
-        def prepare_gem_build_directory
-          run_command "rm -rf #{ gem_build_directory }"
-          FileUtils.mkdir_p gem_build_directory
-        end
 
+          def prepare_gem_build_directory
+            run_command(['rm', '-rf', gem_build_directory])
+            FileUtils.mkdir_p gem_build_directory
+          end
 
-        def publish_gem(gem)
-          run_command "gem push #{ gem } --config-file #{ File.join(Dir.home, '.gem', 'credentials') }"
-        rescue RuntimeError
-          # To prevent the display of an ugly stacktrace.
-          abort "\nGem was not published!"
-        end
 
+          def publish_gem(gem)
+            run_command(['gem', 'push', gem, '--config-file', File.join(Dir.home, '.gem', 'credentials')])
+          rescue RuntimeError
+            # To prevent the display of an ugly stacktrace.
+            abort "\nGem was not published!"
+          end
 
-        def rubygems_api_key
-          ENV['SATORIX_CI_RUBYGEMS_API_KEY']
-        end
 
+          def rubygems_api_key
+            ENV['SATORIX_CI_RUBYGEMS_API_KEY']
+          end
 
-        def rubygems_configuration_file_contents
-          "---\n:rubygems_api_key: #{ rubygems_api_key }"
-        end
 
+          def rubygems_configuration_file_contents
+            "---\n:rubygems_api_key: #{ rubygems_api_key }"
+          end
 
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: satorix
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.6.0
 platform: ruby
 authors:
 - Satorix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake-ruby