blufin-lib 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28d9f465ff5230d850d2c1d876a4e105bf077559
-  data.tar.gz: ff911b1d347254a0054140b7fcd148a5641cfaa3
+  metadata.gz: 781d11b53064e1a5a3dea7d33e7a9d991dd0b7ee
+  data.tar.gz: 4ba21e3918b587754588ca52f4a457885597c68c
 SHA512:
-  metadata.gz: 34aa1c67ceae7a75988e3169616ede84b5a21b91d46f09266e47fb35a8bb85e3adfe51860d7a62ffea085fe9df7cce11467af4ee27f33a4bea4380bc5e7001bd
-  data.tar.gz: 5745185edb426f42e9d7eb6c62b3b7c26507cff9de7ea4b4e14633206d00e79b8aaf1e78ba27d2c9ef4fefe4b6543ce051e11c6fde6549e222848615a1ad62c0
+  metadata.gz: 0c0cd453d915027c66fc137f0346ed9d19fccfc72de22ce75e6535b1edefc929f16ee2c6af11571d27219f043c6af1c0c7fa5d3d82c2216c61818b626e1735b8
+  data.tar.gz: 49d99beb71dedc4a3b8f09bf792f4b1e1fcd552a2598499d60eafc394420b59af100759c44a35612064c4d4dde490e6d73fc83c7b546f149bc10bb6d020d95f3

data/lib/blufin-lib.rb

@@ -1,22 +1,18 @@
 module Blufin
 
-    autoload :Arrays, 'blufin-lib/core/arrays'
-    autoload :Browser, 'blufin-lib/core/browser'
-    autoload :DateTimeUtils, 'blufin-lib/core/datetime_utils'
-    autoload :Encryptor, 'blufin-lib/core/encryptor'
-    autoload :Files, 'blufin-lib/core/files'
-    autoload :Network, 'blufin-lib/core/network'
-    autoload :Numbers, 'blufin-lib/core/numbers'
-    autoload :Routes, 'blufin-lib/core/routes'
-    autoload :SSH, 'blufin-lib/core/ssh'
-    autoload :Strings, 'blufin-lib/core/strings'
-    autoload :Terminal, 'blufin-lib/core/terminal'
-    autoload :Tools, 'blufin-lib/core/tools'
-
-    module Test
-
-        autoload :EnvironmentValidator, 'blufin-lib/test/TestEnvironmentValidator'
-
-    end
+    autoload :Arrays, 'core/arrays'
+    autoload :Browser, 'core/browser'
+    autoload :DateTimeUtils, 'core/datetime_utils'
+    autoload :Encryptor, 'core/encryptor'
+    autoload :Files, 'core/files'
+    autoload :Image, 'core/image'
+    autoload :Network, 'core/network'
+    autoload :Numbers, 'core/numbers'
+    autoload :Routes, 'core/routes'
+    autoload :SSH, 'core/ssh'
+    autoload :Strings, 'core/strings'
+    autoload :Terminal, 'core/terminal'
+    autoload :Tools, 'core/tools'
+    autoload :Validate, 'core/validate'
 
 end

data/lib/{blufin-lib/core → core}/files.rb

@@ -12,7 +12,7 @@ module Blufin
         # will sort the import statements in the same order as IntelliJ would.
         # @return String
         def self.write_file_java(path_and_file, array_of_lines, auto_generated = JAVA_AUTO_GENERATED_EVERY_RUN)
-            raise RuntimeError, "Expected String, instead got:#{path_and_file.class}" unless path_and_file.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             auto_generated_valid = [JAVA_AUTO_GENERATED_EVERY_RUN, JAVA_AUTO_GENERATED_ONCE]
             raise RuntimeError, "Expected .java file, instead got: #{path_and_file}" unless path_and_file =~ /\.java\z/
             raise RuntimeError, "auto_generated must be one of the following: #{auto_generated_valid.join(', ')}" unless auto_generated_valid.include?(auto_generated)
@@ -160,7 +160,7 @@ module Blufin
         # Write an "Array of Lines" to a file -- overwrites file if exists!
         # @return String
         def self.write_file(path_and_file, array_of_lines)
-            raise RuntimeError, "Expected String, instead got:#{path_and_file.class}" unless path_and_file.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             path_and_file = File.expand_path(path_and_file)
             raise RuntimeError, "Expected an array of lines to write to file, instead got: #{array_of_lines.class}" unless array_of_lines.is_a? Array
             prepare_for_file_write(path_and_file)
@@ -184,7 +184,7 @@ module Blufin
         # Write a "String" to a file -- overwrites file if exists!
         # @return void
         def self.write_file_string(path_and_file, content)
-            raise RuntimeError, "Expected String, instead got:#{path_and_file.class}" unless path_and_file.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             path_and_file = File.expand_path(path_and_file)
             raise RuntimeError, "Expected String to write to file, instead got: #{content.class}" unless content.is_a? String
             prepare_for_file_write(path_and_file)
@@ -204,7 +204,7 @@ module Blufin
         # replace -> If TRUE, will replace file rather than writing on next line after regex.
         # @return void
         def self.write_line_to_file(path_and_file, line, regex = nil, only_if_not_exists = true, replace = false)
-            raise RuntimeError, "Expected String, instead got:#{path_and_file.class}" unless path_and_file.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             path_and_file = File.expand_path(path_and_file)
             raise RuntimeError, "File not found: #{path_and_file}" unless file_exists(path_and_file)
             raise RuntimeError, "Expected String to write to file, instead got: #{line.class}" unless line.is_a? String
@@ -252,7 +252,7 @@ module Blufin
         # multiple_occurrences -> If set to TRUE, will remove ALL occurrences from file.
         # @return void
         def self.remove_line_from_file(path_and_file, regex, multiple_occurrences = false)
-            raise RuntimeError, "Expected String, instead got:#{path_and_file.class}" unless path_and_file.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             path_and_file = File.expand_path(path_and_file)
             raise RuntimeError, "Expected Regexp to match to line, instead got: #{regex.class}" unless regex.is_a? Regexp
             raise RuntimeError, "File not found: #{path_and_file}" unless file_exists(path_and_file)
@@ -279,7 +279,7 @@ module Blufin
         # Get content of a file as an "Array of Lines"
         # @return Array
         def self.read_file(path_and_file, start_line = nil, end_line = nil)
-            raise RuntimeError, "Expected String, instead got:#{path_and_file.class}" unless path_and_file.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             line_count    = 0
             path_and_file = File.expand_path(path_and_file)
             raise RuntimeError, "File not found: #{path_and_file}" unless file_exists(path_and_file)
@@ -299,45 +299,38 @@ module Blufin
         # Deletes a file (if exists)
         # @return void
         def self.delete_file(path_and_file)
-            raise RuntimeError, "Expected String, instead got:#{path_and_file.class}" unless path_and_file.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             FileUtils.rm(File.expand_path(path_and_file)) if file_exists(path_and_file)
         end
 
         # Returns TRUE or FALSE depending whether a path exists.
         # @return void
         def self.path_exists(path)
-            raise RuntimeError, "Expected String, instead got:#{path.class}" unless path.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path.class}" unless path.is_a?(String)
             File.directory?(File.expand_path(path))
         end
 
         # Returns TRUE or FALSE depending whether a path exists.
         # @return void
         def self.file_exists(path_and_file)
-            raise RuntimeError, "Expected String, instead got:#{path_and_file.class}" unless path_and_file.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             File.exist?(File.expand_path(path_and_file))
         end
 
-        # Get full path, IE: '~/Repos' would become '/Users/Albert/Repos'
-        # @return String
-        def self.get_full_path(path)
-            raise RuntimeError, "Expected String, instead got:#{path.class}" unless path.is_a?(String)
-            "/#{Blufin::Strings.remove_surrounding_slashes(File.expand_path(path))}"
-        end
-
         # Get and array of files in a directory.
         # @return Array
         def self.get_files_in_dir(path, only_with_extension = nil)
-            raise RuntimeError, "Expected String, instead got:#{path.class}" unless path.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path.class}" unless path.is_a?(String)
             path = "/#{Blufin::Strings.remove_surrounding_slashes(File.expand_path(path))}"
             raise RuntimeError, "Directory doesn't exist: #{path}" unless path_exists(path)
             files = Dir.glob("#{path}/**/*.#{only_with_extension.nil? ? '*' : only_with_extension}")
             files.uniq.sort
         end
 
-        # Get and array of directories in a directory.
+           # Get and array of directories in a directory.
         # @return Array
         def self.get_dirs_in_dir(path, recursive = false)
-            raise RuntimeError, "Expected String, instead got:#{path.class}" unless path.is_a?(String)
+            raise RuntimeError, "Expected String, instead got: #{path.class}" unless path.is_a?(String)
             path = "/#{Blufin::Strings.remove_surrounding_slashes(File.expand_path(path))}"
             raise RuntimeError, "Directory doesn't exist: #{path}" unless path_exists(path)
             dirs = Dir.glob("#{path}/**/*/")
@@ -350,6 +343,8 @@ module Blufin
                 dirs = root_dirs
             end
             dirs.map! { |value| value.gsub(/\/\z/, '') }
+            dirs.uniq!
+            dirs.sort!
             dirs
         end
 
@@ -371,6 +366,21 @@ module Blufin
             create_directory(path)
         end
 
+        # Get the path name ONLY (from a full path).
+        # @return string
+        def self.extract_path_name(path_and_file)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
+            File.dirname(File.expand_path(path_and_file))
+        end
+
+        # Get the file name ONLY (from a full path).
+        # @return string
+        def self.extract_file_name(path_and_file, include_extension = true)
+            raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
+            return File.basename(File.expand_path(path_and_file)) if include_extension
+            return File.basename(File.expand_path(path_and_file), '*') unless include_extension
+        end
+
         private
 
         # Creates path (if not exists) and deletes file (if exists).

data/lib/core/image.rb

@@ -0,0 +1,152 @@
+require 'mini_magick'
+require 'filesize'
+
+module Blufin
+
+    class ImageContainer
+        attr_accessor :width, :height, :size, :size_human, :type, :ratio
+    end
+
+    class Image
+
+        VALID_SIDES = %w(width height)
+
+        # Uses ImageMagick to return details about an image.
+        # @return Hash
+        def self.info(path_and_file)
+            check_image_magick_installed
+            raise RuntimeError, "File not found: #{path_and_file}" unless Blufin::Files::file_exists(path_and_file)
+            img                      = MiniMagick::Image.open(path_and_file)
+            img_container            = ImageContainer.new
+            img_container.width      = img.dimensions[0].to_i
+            img_container.height     = img.dimensions[1].to_i
+            img_container.size       = img.size
+            img_container.size_human = img.human_size
+            img_container.type       = img.type.downcase
+            img_container.ratio      = calc_aspect_ratio(img.dimensions[0].to_i, img.dimensions[1].to_i)
+            img_container
+        end
+
+        # This command crops an image based on a give size and a ration (using ImageMagick).
+        # If dimensions don't match ratio, adjusts accordingly and crops from center.
+        # Must specify if you want @side to be width or height, where your chosen side will match @length and the other gets altered as needed.
+        # @src     - path/file to source image.
+        # @target  - path/file to target image.
+        # side     - the side for which you want to apply the length to (other side will get adjusted accordingly)
+        # length   - the length that you want applied
+        # ratio    - the ratio you want (16:9 and 9:16 will produce different results)
+        # quality  - the higher the quality, the bigger the image.
+        # @return void
+        def self.crop_to_length_and_ratio(src, target, side, length, ratio, quality = 100)
+            d1 = length
+            side.downcase!
+            raise RuntimeError, "Expected integer, instead got: #{d1}" unless d1.to_s =~ /^\d+$/
+            raise RuntimeError, "Expected one of: #{VALID_SIDES.inspect}, instead got: #{side}" unless VALID_SIDES.include?(side)
+            raise RuntimeError, "Unexpected ratio #{Blufin::Terminal::format_highlight(ratio)}, expected something like: 16:9" unless ratio =~ /\d{1,2}:\d{1,2}/
+            raise RuntimeError, "Expected integer between 0 - 100, instead got: #{quality}" unless quality.to_s =~ /^\d+$/ && quality.to_i >= 0 && quality.to_i <= 100
+            raise RuntimeError, "File not found: #{src}" unless Blufin::Files::file_exists(src)
+            # Convert the initial image to match the width.
+            c1 = side == 'width' ? d1 : "x#{d1}"
+            Blufin::Terminal::execute("magick #{src} -resize #{c1} -quality #{quality} #{target}")
+            ac = info(target)
+            d2 = side == 'width' ? calc_height_from_ratio(ratio, d1) : calc_width_from_ratio(ratio, d1)
+            # If the other side is less that what's desired, convert the image using the other orientation.
+            c3 = side == 'width' ? ac.height : ac.width
+            if c3 < d2
+                c2 = side == 'width' ? "x#{d2}" : d2
+                Blufin::Terminal::execute("magick #{src} -resize #{c2} -quality #{quality} #{target}")
+                ac = info(target)
+            end
+            ow = ac.width
+            oh = ac.height
+            if side == 'width'
+                x  = ow > d1 ? ((ow - d1) / 2).to_i : 0
+                y  = oh > d2 ? ((oh - d2) / 2).to_i : 0
+                c4 = d1
+                c5 = calc_height_from_ratio(ratio, d1)
+            else
+                x  = ow > d2 ? ((ow - d2) / 2).to_i : 0
+                y  = oh > d1 ? ((oh - d1) / 2).to_i : 0
+                c4 = calc_width_from_ratio(ratio, d1)
+                c5 = d1
+            end
+            # Do the final crop.
+            Blufin::Terminal::execute("convert #{target} -crop #{c4}x#{c5}+#{x}+#{y} +repage #{target}")
+            # Output details about the image.
+            img = info(target)
+            ts  = target.split('/')
+            puts
+            puts "    \x1B[38;5;40m#{ts[ts.length - 1]}\x1B[38;5;240m \xe2\x80\x94 #{Filesize.from("#{img.size} B").pretty} | #{img.ratio}#{img.ratio != ratio ? ' - For this image, a perfect ratio couldn\'t be achieved :(' : nil}\x1B[0m"
+            puts
+        end
+
+        # Adds text/caption to image.
+        # @return void
+        def self.add_text(src, target, text, x = 35, y = 60, bg = 'black', fg = 'white', point_size = 22, stroke_width = 1)
+            raise RuntimeError, "File not found: #{src}" unless Blufin::Files::file_exists(src)
+            raise RuntimeError, "Expected integer (for x), instead got: #{x}" unless x.to_s =~ /^\d+$/
+            raise RuntimeError, "Expected integer (for y), instead got: #{y}" unless y.to_s =~ /^\d+$/
+            raise RuntimeError, "Expected integer (for point_size), instead got: #{point_size}" unless point_size.to_s =~ /^\d+$/
+            raise RuntimeError, "Expected integer (for stroke_width), instead got: #{stroke_width}" unless stroke_width.to_s =~ /^\d+$/
+            Blufin::Terminal::execute("convert #{src} -undercolor #{bg} -stroke #{fg} -pointsize #{point_size} -strokewidth #{stroke_width} -draw \"text #{x},#{y} '#{text}'\" #{target}")
+        end
+
+        # Calculates the aspect ration (IE: 16:9) from a set of given dimensions.
+        # @return string
+        def self.calc_aspect_ratio(width, height)
+            gcd = gcd(width, height)
+            "#{(width / gcd).to_i}:#{(height / gcd).to_i}"
+        end
+
+        # Calculates width from aspect ratio and height:
+        # IE: 16:9 and 1080 returns -> 1920.
+        # @return int
+        def self.calc_width_from_ratio(ratio, height)
+            raise RuntimeError, "Unexpected ratio #{Blufin::Terminal::format_highlight(ratio)}, expected something like: 16:9" unless ratio =~ /\d{1,2}:\d{1,2}/
+            raise RuntimeError, "Expected integer, instead got: #{height}" unless height.to_s =~ /^\d+$/
+            rs = ratio.split(':')
+            ((height.to_i / rs[1].to_i) * rs[0].to_i).to_i
+        end
+
+        # Calculates height from aspect ratio and width:
+        # IE: 16:9 and 1920 returns -> 1080.
+        # @return int
+        def self.calc_height_from_ratio(ratio, width)
+            raise RuntimeError, "Unexpected ratio #{Blufin::Terminal::format_highlight(ratio)}, expected something like: 16:9" unless ratio =~ /\d{1,2}:\d{1,2}/
+            raise RuntimeError, "Expected integer, instead got: #{width}" unless width.to_s =~ /^\d+$/
+            rs = ratio.split(':')
+            ((width.to_i / rs[0].to_i) * rs[1].to_i).to_i
+        end
+
+        # Gets the greatest-common-denominator. Used to calculate screen aspect ratio.
+        # See: https://stackoverflow.com/questions/14731745/what-exactly-does-do-in-javascript
+        # @return int
+        def self.gcd(a, b)
+            a = a.to_i
+            b = b.to_i
+            return a if b == 0
+            gcd(b, a % b)
+        end
+
+        # Standardizes the way output files are named.
+        # @return string
+        def self.calc_file_name(prefix, ext, side, length, ratio)
+            raise RuntimeError, "Expected integer, instead got: #{length}" unless length.to_s =~ /^\d+$/
+            raise RuntimeError, "Expected one of: #{VALID_SIDES.inspect}, instead got: #{side}" unless VALID_SIDES.include?(side)
+            raise RuntimeError, "Unexpected ratio #{Blufin::Terminal::format_highlight(ratio)}, expected something like: 16:9" unless ratio =~ /\d{1,2}:\d{1,2}/
+            x = side == 'width' ? length : calc_width_from_ratio(ratio, length)
+            y = side == 'width' ? calc_height_from_ratio(ratio, length) : length
+            "#{prefix}-#{x}x#{y}.#{ext.downcase}"
+        end
+
+        private
+
+        # Checks ImageMagick is installed on this system.
+        # @return void
+        def self.check_image_magick_installed
+            Blufin::Terminal::error('ImageMagick might not be installed.', "The command: #{Blufin::Terminal::format_command('magick')} was not found on this system.", true) unless system('magick -version >/dev/null')
+        end
+
+    end
+
+end

data/lib/{blufin-lib/core → core}/network.rb

@@ -7,17 +7,11 @@ module Blufin
         # Checks if internet connection is present.
         # @return boolean|void
         def self.check_machine_is_online
-
             begin
-
-                return true if open('http://www.google.com')
-
+                return true if open('https://www.google.com')
             rescue
-
                 Blufin::Terminal::error('No internet connection', 'This script requires an internet connection and your machine is not online.')
-
             end
-
         end
 
     end

data/lib/{blufin-lib/core → core}/terminal.rb

@@ -1,7 +1,9 @@
 require 'highline/import'
 require 'columnist'
 require 'readline'
+require 'tty-prompt'
 require 'tty-spinner'
+require 'rouge'
 
 module Blufin
 
@@ -70,15 +72,43 @@ module Blufin
         # Executes a command and shows that something is happening (via a cli-spinner)
         # See: https://github.com/piotrmurach/tty-spinner/blob/master/lib/tty/spinner/formats.rb (for spinner options).
         # @return void
-        def self.execute(command, path, format = :dots)
-
-            # TODO NOW - Add execution time to this.
-
-        spinner = TTY::Spinner.new("[:spinner] \x1B[38;5;208m#{command} \x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;240m#{path}\x1B[0m", format: format)
+        def self.execute(command, path = nil, capture = false)
+            t1      = Time.now
+            spinner = TTY::Spinner.new("[:spinner] \x1B[38;5;208m#{command}#{!path.nil? ? " \x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;240m#{path}" : nil}\x1B[0m", format: :dots)
             spinner.auto_spin
-            res = system("cd #{path} && #{command} > /dev/null")
-            spinner.success("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;46mComplete\x1B[0m") if res
-            spinner.error("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;196mFailed\x1B[0m") unless res
+            path = File.expand_path('~/') if path.nil?
+            if capture
+                res = system(`cd #{path} && #{command}`)
+            else
+                res = system("cd #{path} && #{command} > /tmp/execute-output")
+            end
+            t2    = Time.now
+            delta = "#{'%.3f' % (t2 - t1).abs}s"
+            if res || capture
+                spinner.success("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;46mComplete \x1B[38;5;240m(#{delta})\x1B[0m\x1B[0m")
+            else
+                spinner.error("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;196mFailed (#{delta})\x1B[0m")
+                puts "\x1B[38;5;240m"
+                system('cat /tmp/execute-output')
+                puts "\x1B[0m"
+            end
+            res
+        end
+
+        # Same as above but with a proc/lambda instead of a terminal command.
+        # @return void
+        def self.execute_proc(title, proc, verbose: true)
+            raise RuntimeError, "Expected String, instead got:#{title.class}" unless title.is_a?(String)
+            raise RuntimeError, "Expected proc to be an instance of Proc, instead got: #{proc.class}" unless proc.is_a?(Proc)
+            t1      = Time.now
+            spinner = nil
+            spinner = TTY::Spinner.new("[:spinner] \x1B[38;5;208m#{title}\x1B[0m", format: :dots) if verbose
+            spinner.auto_spin if verbose
+            res   = proc.call
+            t2    = Time.now
+            delta = "#{'%.3f' % (t2 - t1).abs}s"
+            spinner.success("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;46mComplete \x1B[38;5;240m(#{delta})\x1B[0m\x1B[0m") if verbose && res
+            spinner.error("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;196mFailed (#{delta})\x1B[0m") if verbose && !res
             res
         end
 
@@ -93,7 +123,7 @@ module Blufin
 
             case type
                 when MSG_INFO
-                    puts "\x1B[38;5;231m\x1B[48;5;2m Executing \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m\n"
+                    puts "\x1B[38;5;231m\x1B[48;5;22m Executing \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m\n"
                 when MSG_WARNING
                     puts "\x1B[38;5;231m\x1B[48;5;202m  Warning  \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m\n"
                 when MSG_ERROR
@@ -130,11 +160,9 @@ module Blufin
         # @return void
         def self.error(title = nil, message = nil, exit_script = true, preceding_blank_line = true, error_text = 'Error')
             puts if preceding_blank_line
-            puts "    \x1B[38;5;231m\x1B[48;5;196m #{error_text} \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
+            puts "    \x1B[38;5;231m\x1B[48;5;124m #{error_text} \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
             parse_messages(message)
-            if exit_script
-                exit
-            end
+            exit if exit_script
         end
 
         # Displays automatic message.
@@ -157,7 +185,7 @@ module Blufin
         # @return void
         def self.success(title = nil, message = nil, preceding_blank_line = true)
             puts if preceding_blank_line
-            puts "  \x1B[38;5;231m\x1B[48;5;2m Success \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
+            puts "  \x1B[38;5;231m\x1B[48;5;22m Success \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
             parse_messages(message)
         end
 
@@ -169,6 +197,16 @@ module Blufin
             parse_messages(message)
         end
 
+        # Displays warning message.
+        # @return void
+        def self.arg_instructions(arg_descriptions, preceding_blank_line = true)
+            puts if preceding_blank_line
+            puts "  \x1B[38;5;231m\x1B[48;5;22m Instructions \x1B[0m \xe2\x86\x92 This command expects the following arguments:\n"
+            arg_descriptions_converted = []
+            arg_descriptions.each_with_index { |x, idx| arg_descriptions_converted << "#{idx + 1}) \x1B[38;5;208m#{x}\x1B[0m" }
+            parse_messages(arg_descriptions_converted)
+        end
+
         # Displays custom message (ideally, keyword should be 7 characters long to match the rest of the output).
         # @return void
         def self.custom(keyword = 'N/A', color = 1, title = nil, message = nil, preceding_blank_line = true)
@@ -179,6 +217,7 @@ module Blufin
 
         # Displays custom message with a progress indicator.
         # @return void
+        # Deprecated
         def self.custom_progress(keyword = 'N/A', color = 1, title = nil, message = nil, preceding_blank_line = true)
             puts if preceding_blank_line
             puts "  \x1B[38;5;231m\x1B[48;5;#{color}m #{keyword} \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
@@ -189,7 +228,7 @@ module Blufin
         # @return String
         def self.format_action(action_text, capitalize = true)
             action_text = action_text.nil? ? 'N/A' : action_text
-            action_text = action_text.upcase if capitalize
+            action_text = action_text.to_s.upcase if capitalize
             "\x1B[38;5;170m#{action_text}\x1B[0m"
         end
 
@@ -215,13 +254,12 @@ module Blufin
         # Returns flag name in consistent, uniform manner.
         # @return String
         def self.format_flag(flag_letter, display_flag_text = true)
-            letter_array = []
             if flag_letter.is_a? String
-                letter_array = Array[flag_letter]
+                letter_array = [flag_letter]
             elsif flag_letter.is_a? Array
                 letter_array = flag_letter
             else
-                Blufin::Terminal::error('Terminal::format_flag expects either String or Array.', nil, true)
+                raise RuntimeError, 'Terminal::format_flag expects either String or Array.'
             end
             flag_txt = ''
             letter_array.each do |letter|
@@ -229,7 +267,7 @@ module Blufin
             end
             xtra_txt = letter_array.length > 1 ? ' flags' : ' flag'
             flag_txt = flag_txt[2..-1]
-            "\x1B[38;5;152m#{flag_txt}#{display_flag_text ? xtra_txt : ''}\x1B[0m"
+            "\x1B[38;5;177m#{flag_txt}#{display_flag_text ? xtra_txt : ''}\x1B[0m"
         end
 
         # Returns action message in consistent, uniform manner.
@@ -286,39 +324,162 @@ module Blufin
                 when 'x'
                     Blufin::Terminal::error('Abandon ship!', ["You have chosen to \x1B[38;5;9mABORT\x1B[38;5;240m the script.", nil, 'Please note that whenever you do this, any scripted tasks which were running', 'will have been interrupted mid-script. This may (or may not) cause problems.'], true)
                 else
+                    raise RuntimeError, "Un-handled response: #{response.downcase}"
             end
         end
 
         # Shows a prompt waiting for user input.
         # If validation_proc is passed, the Proc must return TRUE in order for validation to pass.
         # @return string
-        def self.prompt_for_input(message, subtitle_array = nil, nil_allowed = true, preceding_blank_line = true, clear_screen = true, validation_proc = nil, validation_message = 'Invalid value!')
+        # @deprecated
+        def self.prompt_for_input(title = 'Input Required', message = nil, subtitle_array = nil, validation_proc = nil, validation_message = 'Invalid value', clear_screen = true, preceding_blank_line = true)
             system('clear') if clear_screen
             puts if preceding_blank_line
-            puts "  \x1B[38;5;231m\x1B[48;5;125m Question \x1B[0m \xe2\x86\x92 #{message}\n"
+            puts "  \x1B[38;5;231m\x1B[48;5;125m #{title.upcase} \x1B[0m \xe2\x86\x92 #{message} \x1B[38;5;240m\xe2\x80\x94 \x1B[38;5;160m(or 'X' to cancel)\x1B[0m\n"
             parse_messages(subtitle_array) unless subtitle_array.nil?
             puts if subtitle_array.nil?
             response = nil
             while response.nil?
                 response = Readline::readline("     \x1B[38;5;245m=>\x1B[0m ", true)
-                unless nil_allowed
-                    response.strip!
-                    response = nil if response == '' || response.nil?
-                end
                 unless validation_proc.nil?
                     raise RuntimeError, "Expected validation_proc to be an instance of Proc, instead got: #{validation_proc.class}" unless validation_proc.is_a?(Proc)
-                    unless validation_proc.call(response)
+                    unless response.upcase == 'X' || validation_proc.call(response)
                         puts "     \x1B[38;5;245m=>\x1B[0m \x1B[38;5;196mERROR\x1B[0m \xe2\x80\x94 #{validation_message}\n"
                         response = nil
                     end
                 end
             end
+            abort if response.upcase == 'X'
             puts
             response
         end
 
+        # See: https://github.com/piotrmurach/tty-prompt#1-usage
+        # See: https://www.rubydoc.info/gems/tty-prompt
+        # => What is your name? (Albert Rannetsperger)
+        # @return string
+        def self.prompt_ask(question, default: nil, help: nil, validation_regex: nil)
+            puts display_prompt_help(help) unless help.nil?
+            prompt = TTY::Prompt.new
+            prompt.ask(display_prompt_text(question), default: default) do |q|
+                q.modify :strip
+                q.validate validation_regex unless validation_regex.nil?
+            end
+        end
+
+        # => Do you like Ruby? (Y/n)
+        # @return boolean
+        def self.prompt_yes?(question)
+            begin
+                prompt = TTY::Prompt.new
+                return prompt.yes?(display_prompt_text(question))
+            rescue
+                prompt_yes?(question)
+            end
+        end
+
+        # => What is your secret? ••••
+        # @return string
+        def self.prompt_mask(question)
+            prompt = TTY::Prompt.new
+            prompt.mask(display_prompt_text(question))
+        end
+
+        # Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+        # ‣ Scorpion
+        #   Kano
+        #   Jax
+        # @options = %w(Scorpion Kano Jax)
+        # @options = [{ :text => 'Description', :value => '1', :disabled => nil/'Reason' }]
+        # @return string
+        def self.prompt_select(question, options, help: nil, per_page: 20)
+            raise RuntimeError, "Expected Array, instead got #{options.class}" unless options.is_a?(Array)
+            raise RuntimeError, 'Array cannot be empty.' unless options.any?
+            puts display_prompt_help(help) unless help.nil?
+            prompt = TTY::Prompt.new
+            if options[0].is_a?(String)
+                prompt.select(display_prompt_text(question), options, per_page: per_page)
+            elsif options[0].is_a?(Hash)
+                prompt.select(display_prompt_text(question), per_page: per_page) do |menu|
+                    options.each do |option|
+                        raise RuntimeError, "Expected option to be Hash, instead got: (#{option.class}) #{option.inspect}" unless option.is_a?(Hash)
+                        raise RuntimeError, 'Option is missing key => :text' unless option.has_key?(:text)
+                        raise RuntimeError, 'Option is missing key => :value' unless option.has_key?(:value)
+                        raise RuntimeError, "Expected :disabled option to be String, instead got: #{option[:disabled].class}" if option.has_key?(:disabled) && !option[:disabled].is_a?(String) && !option[:disabled].nil?
+                        menu.choice option[:text], option[:value] unless option.has_key?(:disabled)
+                        menu.choice option[:text], option[:value], disabled: "\x1B[38;5;196m#{option[:disabled]}\x1B[0m" if option.has_key?(:disabled)
+                    end
+                end
+            else
+                raise RuntimeError, "Expected options Array to consist of either Strings or Hashes, instead got: #{options.inspect}"
+            end
+        end
+
+        # Select drinks? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)"
+        # ‣ ⬡ vodka
+        #   ⬡ beer
+        #   ⬡ wine
+        #   ⬡ whisky
+        #   ⬡ bourbon
+        # @options = %w(vodka beer wine whisky bourbon)
+        # @return Array
+        def self.prompt_multi_select(question, options)
+            raise RuntimeError, "Expected Array, instead got #{options.class}" unless options.is_a?(Array)
+            prompt = TTY::Prompt.new
+            prompt.multi_select(display_prompt_text(question), options)
+        end
+
+        # Select an editor?
+        #   1) emacs
+        #   2) nano
+        #   3) vim
+        #   Choose 1-3 [1]:
+        # @options = %w(emacs nano vim)
+        # @return Array
+        def self.prompt_enum_select(question, options)
+            raise RuntimeError, "Expected Array, instead got #{options.class}" unless options.is_a?(Array)
+            prompt = TTY::Prompt.new
+            prompt.enum_select(display_prompt_text(question), options)
+        end
+
+        # Overwrite Gemfile? (enter "h" for help) [y,n,a,d,q,h]
+        # @options = [
+        #     { key: 'y', name: 'overwrite this file', value: :yes },
+        #     { key: 'n', name: 'do not overwrite this file', value: :no },
+        #     { key: 'a', name: 'overwrite this file and all later files', value: :all },
+        #     { key: 'd', name: 'show diff', value: :diff },
+        #     { key: 'q', name: 'quit; do not overwrite this file ', value: :quit }
+        # ]
+        # @return multiple
+        def self.prompt_expand(question, options)
+            raise RuntimeError, "Expected Array, instead got #{options.class}" unless options.is_a?(Array)
+            options.each do |option|
+                found_key   = false
+                found_name  = false
+                found_value = false
+                option.each do |k, v|
+                    case k
+                        when :key
+                            found_key = true
+                        when :name
+                            found_name = true
+                        when :value
+                            found_value = true
+                        else
+                            raise RuntimeError, "Unrecognized Key: #{k}"
+                    end
+                end
+                raise RuntimeError, "Option is missing #{Blufin::Terminal::format_highlight('key')}: #{option.inspect}" unless found_key
+                raise RuntimeError, "Option is missing #{Blufin::Terminal::format_highlight('name')}: #{option.inspect}" unless found_name
+                raise RuntimeError, "Option is missing #{Blufin::Terminal::format_highlight('value')}: #{option.inspect}" unless found_value
+            end
+            prompt = TTY::Prompt.new
+            prompt.expand(display_prompt_text(question), options)
+        end
+
         # Gives a prompt where ANY KEY will continue executing the script.
         # @return void
+        # @deprecated
         def self.any_key_to_continue(text = nil, preceding_blank_line = true)
             STDOUT.flush
             puts if preceding_blank_line
@@ -383,6 +544,30 @@ module Blufin
             Blufin::Terminal::automatic(message, file_output, preceding_blank_line)
         end
 
+        # Outputs code to terminal that is syntax highlighted.
+        # @return void
+        def self.code_highlight_file(path_and_file, type, indent = 5)
+            raise RuntimeError, "File does not exist: #{path_and_file}" unless Blufin::Files::file_exists(path_and_file)
+            code_highlight(File.read(path_and_file), type, indent)
+        end
+
+        # Outputs code to terminal that is syntax highlighted.
+        # @return void
+        def self.code_highlight(string, type, indent = 5)
+            raise RuntimeError, "Expected String, instead got:#{string.class}" unless string.is_a?(String)
+            type  = type.downcase
+            types = {
+                'yml'  => Rouge::Lexers::YAML.new,
+                'json' => Rouge::Lexers::JSON.new
+            }
+            raise RuntimeError, "Lexer not defined for type: #{type}" unless types.has_key?(type)
+            repeat    = ' ' * indent
+            formatter = Rouge::Formatters::Terminal256.new
+            formatter.format(types[type].lex(string)).split("\n").each do |line|
+                puts "#{repeat}#{line}"
+            end
+        end
+
         private
 
         # Parses messages for various output functions.
@@ -408,6 +593,17 @@ module Blufin
             end
         end
 
-    end
+        # Standardized way of displaying prompts help.
+        # @return string
+        def self.display_prompt_help(help)
+            "\x1B[38;5;240m#{help}\x1B[0m"
+        end
 
+        # Standardized way of displaying prompts text.
+        # @return string
+        def self.display_prompt_text(question)
+            "\x1B[38;5;208m#{question}\x1B[38;5;240m =>\x1B[0m"
+        end
+
+    end
 end

data/lib/core/validate.rb

@@ -0,0 +1,51 @@
+module Blufin
+
+    class Validate
+
+        # Passing arguments as follows...
+        #    @expected: { 'required_key' => true, 'optional_key' => false }
+        #      @actual: %w(required_key non_existent_key)
+        # @description: Hint of where the error occurred.
+        # @return null - If errors, will raise exception.
+        def self.assert_valid_keys(expected, actual, description)
+            raise RuntimeError, "Expected Hash, instead got: #{expected.class}" unless expected.is_a?(Hash)
+            raise RuntimeError, "Expected Array, instead got: #{actual.class}" unless actual.is_a?(Array)
+            errors        = []
+            required_keys = []
+            optional_keys = []
+            expected.each do |k, v|
+                raise RuntimeError, "Expected value for #{k} to be boolean, instead got: #{v.class}" unless !!v == v
+                required_keys << k if v
+                optional_keys << k unless v
+            end
+            actual.each do |n|
+                errors << "Unexpected Key: #{n}" unless required_keys.include?(n) || optional_keys.include?(n)
+                required_keys.delete(n) if required_keys.include?(n)
+                optional_keys.delete(n) if optional_keys.include?(n)
+            end
+            errors << "Missing required keys: #{required_keys.inspect}" unless required_keys.length == 0
+            if errors.length == 0
+                expected_key_order = []
+                expected.each do |k, v|
+                    expected_key_order << k if v
+                    expected_key_order << k if !v && actual.include?(k)
+                end
+                unless expected_key_order.to_s == actual.to_s
+                    errors << "Expected key order doesn't match:"
+                    errors << ''
+                    errors << "  Expected: #{expected_key_order.inspect}"
+                    errors << "    Actual: #{actual.inspect}"
+                end
+            end
+            return unless errors.length > 0
+            # Output useful errors (hopefully).
+            puts
+            puts Blufin::Terminal::format_invalid(description)
+            puts expected.to_yaml
+            puts
+            errors.each { |error| puts "\x1B[38;5;196m  #{error}\x1B[0m" }
+            raise RuntimeError, 'Keys are invalid, missing and/or not in the expected order.'
+        end
+
+    end
+end

data/lib/version.rb

@@ -1 +1 @@
-BLUFIN_LIB_VERSION = '1.4.0'
+BLUFIN_LIB_VERSION = '1.5.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blufin-lib
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Albert Rannetsperger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-25 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -38,20 +38,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
 description: Common functionality shared between ruby gems.
 email: alb3rtuk@hotmail.com
 executables: []
@@ -59,19 +73,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/blufin-lib.rb
-- lib/blufin-lib/core/arrays.rb
-- lib/blufin-lib/core/browser.rb
-- lib/blufin-lib/core/datetime_utils.rb
-- lib/blufin-lib/core/encryptor.rb
-- lib/blufin-lib/core/files.rb
-- lib/blufin-lib/core/network.rb
-- lib/blufin-lib/core/numbers.rb
-- lib/blufin-lib/core/routes.rb
-- lib/blufin-lib/core/ssh.rb
-- lib/blufin-lib/core/strings.rb
-- lib/blufin-lib/core/terminal.rb
-- lib/blufin-lib/core/tools.rb
-- lib/blufin-lib/test/TestEnvironmentValidator.rb
+- lib/core/arrays.rb
+- lib/core/browser.rb
+- lib/core/datetime_utils.rb
+- lib/core/encryptor.rb
+- lib/core/files.rb
+- lib/core/image.rb
+- lib/core/network.rb
+- lib/core/numbers.rb
+- lib/core/routes.rb
+- lib/core/ssh.rb
+- lib/core/strings.rb
+- lib/core/terminal.rb
+- lib/core/tools.rb
+- lib/core/validate.rb
 - lib/version.rb
 homepage: https://github.com/alb3rtuk
 licenses:

data/lib/blufin-lib/test/TestEnvironmentValidator.rb

@@ -1,98 +0,0 @@
-module Blufin
-
-    module Test
-
-        class EnvironmentValidator
-
-            CHECK_API       = 'check-api'
-            CHECK_CRON      = 'check-cron'
-            CHECK_WORKER    = 'check-worker'
-            CHECK_MYSQL     = 'check-mysql'
-            CHECK_RABBIT_MQ = 'check-rabbit-mq'
-
-            def initialize(opts, base_prefix)
-
-                raise RuntimeError, "Opts must be an array, you passed: #{opts.class}" unless opts.is_a?(Hash)
-
-                @base_prefix = base_prefix
-
-                valid_opts = [CHECK_API, CHECK_CRON, CHECK_WORKER, CHECK_MYSQL, CHECK_RABBIT_MQ]
-
-                opts.keys.each { |opt| raise RuntimeError, "#{opt} is not a valid value" unless valid_opts.include?(opt) }
-
-                Blufin::Terminal::info('Checking for necessary components...') if opts.length > 0
-
-                validation_results = []
-                validation_results << check_api(opts[CHECK_API]) if opts.keys.include?(CHECK_API)
-                validation_results << check_cron(opts[CHECK_CRON]) if opts.keys.include?(CHECK_CRON)
-                validation_results << check_worker(opts[CHECK_WORKER]) if opts.keys.include?(CHECK_WORKER)
-                validation_results << check_mysql if opts.keys.include?(CHECK_MYSQL)
-                validation_results << check_rabbit_mq if opts.keys.include?(CHECK_RABBIT_MQ)
-
-                Blufin::Terminal::error('Your environment is not setup correctly. Please check the above output.', nil, true) if validation_results.include?(false)
-
-                puts
-
-            end
-
-            private
-
-            # Checks that the API is running.
-            # @return void
-            def check_api(uri)
-                check_service_common(uri, 'api')
-            end
-
-            # Checks that the WORKER is running.
-            # @return void
-            def check_cron(uri)
-                check_service_common(uri, 'cron')
-            end
-
-            # Checks that the WORKER is running.
-            # @return void
-            def check_worker(uri)
-                check_service_common(uri, 'worker')
-            end
-
-            # Checks that the MySQL is running.
-            # @return void
-            def check_mysql
-                if system('mysqladmin version >& /dev/null')
-                    Blufin::Terminal::output(Blufin::Terminal::format_highlight('mysql'), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Pass', 22)
-                    true
-                else
-                    Blufin::Terminal::output(Blufin::Terminal::format_invalid('mysql'), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Fail', 196)
-                    false
-                end
-            end
-
-            # Checks that the RabbitMQ is running.
-            # @return void
-            def check_rabbit_mq
-                if system('rabbitmqadmin --help >& /dev/null')
-                    Blufin::Terminal::output(Blufin::Terminal::format_highlight('rabbit-mq'), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Pass', 22)
-                    return true
-                else
-                    Blufin::Terminal::output(Blufin::Terminal::format_invalid('rabbit-mq'), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Fail', 196)
-                end
-                false
-            end
-
-            # Common method for checking Java services are running.
-            def check_service_common(uri, service_name)
-                service_name = "#{@base_prefix}-#{service_name}"
-                if system("curl -I #{uri} -k >& /dev/null")
-                    Blufin::Terminal::output(Blufin::Terminal::format_highlight(service_name), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Pass', 22)
-                    return true
-                else
-                    Blufin::Terminal::output(Blufin::Terminal::format_invalid(service_name), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Fail', 196)
-                end
-                false
-            end
-
-        end
-
-    end
-
-end