blufin-lib 1.7.6 → 1.8.0

data/lib/core/routes.rb

@@ -67,11 +67,30 @@ module Blufin
             flags_set = 0
             possible_flags.each { |possible_flag|
                 raise RuntimeError, "@opts does not contain flag: #{possible_flag}" unless opts.has_key?(possible_flag)
-                flags_set += 1 if opts[possible_flag]
+                flags_set += 1 if opts[possible_flag] && !opts[possible_flag].nil?
             }
             Blufin::Terminal::error("Cannot set #{Blufin::Terminal::format_highlight('more than one')} of the following flags: \x1B[38;5;172m#{possible_flags.join(', ')}\x1B[0m") if flags_set > 1
         end
 
+        # Prevents code from running twice.
+        # @return boolean
+        def self.code_already_ran(tmp_key, timeout = 1000)
+            t = Time.new
+            epoch = t.strftime('%s%3N')
+            epoch_previous = nil
+            tmp_file = "/tmp/#{tmp_key}-last-run-epoch.txt"
+            if Blufin::Files::file_exists(tmp_file)
+                Blufin::Files::read_file(tmp_file).each do |line|
+                    epoch_previous = line
+                    break
+                end
+            end
+            Blufin::Files::write_file(tmp_file, [epoch])
+            return if epoch_previous.nil?
+            diff = (epoch.to_i - epoch_previous.to_i).abs
+            diff < timeout
+        end
+
         private
 
         # Does exactly what it says on the Tin.

data/lib/core/strings.rb

@@ -97,6 +97,22 @@ module Blufin
             rs
         end
 
+        # Strips all newline character(s) -- IE: "abc\n" -> "abc"
+        # Be careful, if multiple newlines are in string, they will all get stripped and you might end up with weird output.
+        # @return string
+        def self.strip_newline(string)
+            raise RuntimeError, "Expected String, instead got: #{string.class}" unless string.is_a?(String)
+            string.gsub(/[\r\n]+/m, '').strip
+        end
+
+        # Removes all colors from a string.
+        # https://stackoverflow.com/questions/16032726/removing-color-decorations-from-strings-before-writing-them-to-logfile
+        # @return string
+        def self.strip_ansi_colors(string)
+            raise RuntimeError, "Expected String, instead got: #{string.class}" unless string.is_a?(String)
+            string.gsub(/\e\[([;\d]+)?m/, '').strip
+        end
+
         private
 
         # Internal string validation.

data/lib/core/terminal.rb

@@ -22,6 +22,7 @@ module Blufin
         MSG_PROGRESS        = 'progress'
         MSG_CUSTOM          = 'custom'
         MSG_CUSTOM_AUTO_PAD = 'custom_auto_pad'
+        ERR_OUTPUT          = '/tmp/execute-output'
 
         # Runs a series of commands in the terminal.
         # @return void
@@ -77,30 +78,39 @@ module Blufin
         # If capture: is false, returns TRUE:FALSE whether command was successful or not.
         # If capture: is true, returns raw output of command.
         # See: https://github.com/piotrmurach/tty-spinner/blob/master/lib/tty/spinner/formats.rb (for spinner options).
-        # @return void
-        def self.execute(command, path = nil, capture: false, verbose: true, text: nil)
+        # @return idx-1 => Command was successful (exit code 0) will output TRUE if capture: FALSE or otherwise STDOUT will be returned, IE: 'On branch master'
+        # @return idx-2 => STDERR (if any), IE: anything written to /tmp/execute-output
+        def self.execute(command, path = nil, capture: false, verbose: true, text: nil, error_output: ERR_OUTPUT, display_error: true, ignore_error: false)
             text    = text.is_a?(String) ? text : command
             t1      = Time.now
             spinner = TTY::Spinner.new("[:spinner] \x1B[38;5;208m#{text}#{!path.nil? ? " \x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;240m#{path}" : nil}\x1B[0m", format: :dots) if verbose
             spinner.auto_spin if verbose
             path = File.expand_path('~/') if path.nil?
+            path = File.expand_path(path) unless path.nil?
+            `echo '' > #{ERR_OUTPUT}`
             if capture
-                res = `cd #{path} && #{command}`
+                res = `cd #{path} && #{command} 2>#{error_output}`
             else
-                res = system("cd #{path} && #{command} > /tmp/execute-output")
+                res = system("cd #{path} && #{command} 1>/dev/null 2>#{error_output}")
             end
             t2    = Time.now
             delta = "#{'%.3f' % (t2 - t1).abs}s"
-            if res || capture
+            error = `cat #{ERR_OUTPUT}`.to_s.strip
+            if (res && error.length == 0) || ignore_error
                 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 = true unless capture
             else
                 spinner.error("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;196mFailed (#{delta})\x1B[0m") if verbose
                 # If there is an error, output it (even if verbose == false).
-                puts "\x1B[38;5;240m"
-                system('cat /tmp/execute-output')
-                puts "\x1B[0m"
+                if error.length > 0 && display_error
+                    puts "\x1B[38;5;240m"
+                    system("cat #{ERR_OUTPUT}")
+                    puts "\x1B[0m"
+                end
+                res = false unless capture
             end
-            res
+            error = nil if error.nil? || error.strip == ''
+            return res, error
         end
 
         # Same as above but with a proc/lambda instead of a terminal command.
@@ -124,11 +134,9 @@ module Blufin
         # If CUSTOM, title must be 11 characters to match existing scheme.
         # @return void
         def self.output(message = 'No message', type = MSG_INFO, title = nil, bg_color = nil)
-
             raise RuntimeError, "'title' cannot be nil." if title.nil? && [MSG_CUSTOM, MSG_CUSTOM_AUTO_PAD].include?(type)
             raise RuntimeError, "'bg_color' cannot be nil." if bg_color.nil? && [MSG_CUSTOM, MSG_CUSTOM_AUTO_PAD].include?(type)
             raise RuntimeError, "'title' cannot be more that 9 characerts when MSG_CUSTOM_AUTO_PAD is the message type." if type == MSG_CUSTOM_AUTO_PAD && title.length > 9
-
             case type
                 when MSG_INFO
                     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"
@@ -151,8 +159,7 @@ module Blufin
                 when MSG_CUSTOM_AUTO_PAD
                     puts "\x1B[38;5;231m#{''.rjust((9 - title.length), ' ')}\x1B[48;5;#{bg_color}m #{title} \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m\n"
                 else
-                    puts "'#{type}' is not a valid Terminal::output() type.\n"
-                    exit
+                    raise RuntimeError, "Invalid Terminal::output type: #{type}"
             end
         end
 
@@ -170,7 +177,7 @@ module Blufin
             puts if preceding_blank_line
             puts "    \x1B[38;5;231m\x1B[48;5;124m #{error_text} \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
             parse_messages(message)
-            exit if exit_script
+            exit 1 if exit_script
         end
 
         # Displays automatic message.
@@ -607,7 +614,10 @@ module Blufin
             type  = type.downcase
             types = {
                 'yml'  => Rouge::Lexers::YAML.new,
-                'json' => Rouge::Lexers::JSON.new
+                'json' => Rouge::Lexers::JSON.new,
+                'js'   => Rouge::Lexers::Javascript.new,
+                'java' => Rouge::Lexers::Javascript.new,
+                'sass' => Rouge::Lexers::Sass.new
             }
             raise RuntimeError, "Lexer not defined for type: #{type}" unless types.has_key?(type)
             repeat    = ' ' * indent

data/lib/core/update.rb

@@ -0,0 +1,15 @@
+module Blufin
+
+    class Update
+
+        # Updates ruby-gem.
+        # @return void
+        def self.run(gem_name)
+
+            raise RuntimeError, "Update #{gem_name}. Not yet implemented!"
+
+        end
+
+    end
+
+end

data/lib/core/yml.rb

@@ -0,0 +1,43 @@
+module Blufin
+
+    class Yml
+
+        # Validate and initialize a YML file.
+        # @return Hash
+        def self.read_file(content_file, schema_file)
+            content_file = File.expand_path(content_file)
+            schema_file  = File.expand_path(schema_file)
+            # Check file(s) exist.
+            [content_file, schema_file].each { |file| Blufin::Terminal::error("File not found: #{schema_file}") unless Blufin::Files::file_exists(file) }
+            # Parse the schema file.
+            begin
+                schema_file_parsed = YAML.load_file(schema_file)
+            rescue => e
+                Blufin::Terminal::error("Failed to parse schema file: #{Blufin::Terminal::format_directory(schema_file)}", e.message)
+            end
+            # Initialize the validator.
+            validator = Kwalify::Validator.new(schema_file_parsed)
+            # Validate the content file.
+            begin
+                document = YAML.load_file(content_file)
+                # noinspection RubyArgCount
+                errors = validator.validate(document)
+            rescue => e
+                Blufin::Terminal::error("Failed to parse content file: #{Blufin::Terminal::format_directory(content_file)}", e.message)
+            end
+            # If errors occurred, display and bomb-out.
+            if errors && !errors.empty?
+                errors_output = []
+                errors.each { |e|
+                    errors_output << "[#{e.path}] #{e.message}"
+                }
+                Blufin::Terminal::error("File had errors: #{Blufin::Terminal::format_directory(content_file)}", errors_output)
+                exit
+            end
+            # Otherwise, return valid YML.
+            document
+        end
+
+    end
+
+end

data/lib/generate/generate_base.rb

@@ -0,0 +1,25 @@
+module Blufin
+
+    class GenerateBase
+
+        OUTPUT_GENERATE = 'generated'
+        OUTPUT_SKIP     = 'exists'
+
+        # Standardized output for code-generation.
+        # @return void
+        def self.output(message, type)
+
+            case type
+                when OUTPUT_GENERATE
+                    puts "\x1B[38;5;231m\x1B[48;5;55m Generated \x1B[0m \xe2\x86\x92 \x1B[38;5;182m#{message}\x1B[0m"
+                when OUTPUT_SKIP
+                    puts " \x1B[38;5;246m\x1B[48;5;234m Skipping \x1B[0m \xe2\x86\x92 \x1B[38;5;240m#{message}\x1B[0m"
+                else
+                    raise "Unrecognized output type: #{type}"
+            end
+
+        end
+
+    end
+
+end

data/lib/generate/generate_ui_routes.rb

@@ -0,0 +1,165 @@
+module Blufin
+
+    class GenerateUiRoutes
+
+        SCHEMA_FILE = "#{Blufin::Base::get_base_path}#{Blufin::Base::OPT_PATH}/schema/routes.yml"
+        HOME_TERM   = 'dashboard'
+
+        # Generates routes in the UI.
+        # @return void
+        def self.run(project)
+            raise RuntimeError, "Expected project type to be: #{Blufin::Projects::TYPE_UI}, instead got: #{project[Blufin::Projects::TYPE]}" unless project[Blufin::Projects::TYPE] == Blufin::Projects::TYPE_UI
+            @errors          = []
+            @warnings        = []
+            @files           = []
+            @files_to_create = []
+            begin
+                @output = <<TEMPLATE
+const routes = [
+    {
+TEMPLATE
+                project_path      = Blufin::Projects::get_project_path(project[Blufin::Projects::PROJECT_ID], true)
+                routes_file       = "#{project_path}/#{project[Blufin::Projects::UI][Blufin::Projects::ROUTES_FILE]}"
+                routes_yml        = Blufin::Yml::read_file(routes_file, SCHEMA_FILE)
+                target_file       = "#{project_path}/src/#{Blufin::Strings::remove_surrounding_slashes(routes_yml['RoutesFile'])}"
+                layout            = routes_yml['Layout']
+                pages_root        = routes_yml['PagesRoot']
+                pages_not_found   = routes_yml['Pages404']
+                path_pages_ignore = []
+                path_to_pages     = "#{project_path}/src/#{pages_root}"
+                # Add ignore path(s) -- if exists.
+                routes_yml['Ignore'].each { |ignore_path| path_pages_ignore << "#{Blufin::Strings::remove_surrounding_slashes(ignore_path)}" } if routes_yml.has_key?('Ignore')
+                routes = routes_yml['Routes']
+                routes.each_with_index do |route, idx|
+                    comma       = route.has_key?('Children') ? ',' : nil
+                    parent_path = route['Parent']['Path']
+                    @output     += <<TEMPLATE
+        path: '/#{route['Parent'].has_key?('RootPath') && route['Parent']['RootPath'] ? nil : parent_path}',
+        sectionName: '#{route['Parent']['Name']}',
+        sectionIcon: '#{route['Parent']['Icon']}',
+        component: () => import('./../#{layout}')#{comma}
+TEMPLATE
+                    file   = parent_path == HOME_TERM ? "#{pages_root}/#{parent_path}/#{HOME_TERM}.vue" : "#{pages_root}/#{parent_path}/#{parent_path}-#{HOME_TERM}.vue"
+                    prefix = parent_path == HOME_TERM ? 'dashboard/' : nil
+                    process_file(file, project_path)
+                    if route.has_key?('Children')
+                        @output += <<TEMPLATE
+        children: [
+            {
+                path: '',
+                component: () => import('./../#{file}')
+            },
+TEMPLATE
+                        children = route['Children']
+                        children.each_with_index do |child, idx|
+                            comma    = idx == children.length - 1 ? nil : ','
+                            file     = "#{pages_root}/#{parent_path}/#{child['Path']}.vue"
+                            disabled = child.has_key?('Disabled') && child['Disabled'] ? "\n                disabled: true," : nil
+                            process_file(file, project_path)
+                            @output += <<TEMPLATE
+            {
+                path: '#{prefix}#{child['Path']}',
+                name: '#{child['Name']}',#{disabled}
+                component: () => import('./../#{file}')
+            }#{comma}
+TEMPLATE
+                        end
+                        @output += "        ]\n"
+                    end
+
+                    if idx == routes.length - 1
+                        @output += <<TEMPLATE
+    }
+TEMPLATE
+                    else
+                        @output += <<TEMPLATE
+    },
+    {
+TEMPLATE
+                    end
+                end
+
+                @output += <<TEMPLATE
+];
+
+if (process.env.MODE !== 'ssr') {
+    routes.push({
+        path: '*',
+        component: () => import('./../#{pages_not_found}')
+    });
+}
+
+export default routes;
+TEMPLATE
+            rescue => e
+                Blufin::Terminal::print_exception(e)
+            end
+
+            # Write the output to the file.
+            Blufin::Files::write_file(target_file, Blufin::Arrays::convert_string_to_line_array(@output))
+
+            # Output message.
+            Blufin::Terminal::info('Generating route file(s):') if @files_to_create.any?
+
+            # Write all the blank route files.
+            @files_to_create.each do |ftc|
+                if Blufin::Files::file_exists(ftc)
+                    Blufin::GenerateBase::output(ftc, Blufin::GenerateBase::OUTPUT_SKIP)
+                else
+                    Blufin::Files::write_file(ftc, Blufin::Arrays::convert_string_to_line_array(get_blank_file_content))
+                    Blufin::GenerateBase::output(ftc, Blufin::GenerateBase::OUTPUT_GENERATE)
+                end
+            end
+
+            puts if @files_to_create.any?
+
+            # Check for rogue files.
+            Blufin::Files::get_files_in_dir(path_to_pages).each do |file|
+                next if file =~ /#{path_to_pages}\/(#{path_pages_ignore.join('|')})/
+                unless @files_to_create.include?(file)
+                    @warnings << "Found rogue file: #{Blufin::Terminal::format_invalid(file)}"
+                end
+            end
+
+            return @errors, @warnings
+
+        end
+
+        private
+
+        # Ensures that we're not defining a path twice.
+        # Creates file if not exists
+        # @return void
+        def self.process_file(file, project_path)
+            Blufin::Terminal::error("Duplicate file: #{Blufin::Terminal::format_invalid(file)}", 'Your configuration would produce a duplicate file. Please fix.') if @files.include?(file)
+            @files << file
+            @files_to_create << "#{project_path}/src/#{file}"
+        end
+
+        # Returns the contents of a blank file.
+        # @return string
+        def self.get_blank_file_content
+            <<TEMPLATE
+<template>
+    <div>
+        <base-title h="5" :nudge-right="30" :nudge-up="10">{{ $route.name }}</base-title>
+    </div>
+</template>
+
+<script type="text/ecmascript-6">
+export default {
+    data() {
+        return {
+            test: this.$route.path
+        };
+    }
+};
+</script>
+
+<style scoped type="text/scss" lang="scss"></style>
+TEMPLATE
+        end
+
+    end
+
+end

data/lib/version.rb

@@ -1 +1 @@
-BLUFIN_LIB_VERSION = '1.7.6'
+BLUFIN_LIB_VERSION = '1.8.0'

data/opt/schema/projects.yml

@@ -56,7 +56,15 @@ mapping:
             Remote:
               required: yes
             ProjectRoot:
-              required: yes
+              required: no
+        Upstream:
+          type: seq
+          sequence:
+          - type: str
+        Downstream:
+          type: seq
+          sequence:
+          - type: str
         Run:
           type: map
           mapping:
@@ -137,4 +145,9 @@ mapping:
               type: seq
               required: yes
               sequence:
-                - type: str
+                - type: str
+        UI:
+          type: map
+          mapping:
+            RoutesFile:
+              required: yes

data/opt/schema/routes.yml

@@ -0,0 +1,44 @@
+type: map
+mapping:
+  Layout:
+    required: true
+  PagesRoot:
+    required: true
+  Pages404:
+    required: true
+  RoutesFile:
+    required: true
+  Ignore:
+    type: seq
+    sequence:
+      - type: str
+  Routes:
+    type: seq
+    required: true
+    sequence:
+      - type: map
+        mapping:
+          Parent:
+            type: map
+            required: true
+            mapping:
+              Path:
+                required: true
+              Name:
+                required: true
+              Icon:
+                required: true
+              RootPath:
+                type: bool
+          Children:
+            type: seq
+            sequence:
+              - type: map
+                required: true
+                mapping:
+                  Path:
+                    required: true
+                  Name:
+                    required: true
+                  Disabled:
+                    type: bool