blufin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfeeca4906f67d952ae139a35756520b322bc3ad
+  data.tar.gz: 88570df1555e0878c833f036eb7eaba0c3ef72ab
+SHA512:
+  metadata.gz: '048dae1911dda7be0142c69b85b8bbbecc71e5e854c083b9b20858f08535a9c5db073d4d2097817647c7ea2571f9db23ffcf2827a8069aea0a7236d0435aec1f'
+  data.tar.gz: 90ec701ffad0f5ef265d68663420e5231bf65aff0bb50dff31f8feb16a1ce0f135fdd04f95416a0e019e14e768dc2220a3fd1223063b2a6e8e44ba3456ce8c06

data/bin/bf

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'blufin'
+
+App::execute

data/bin/blufin

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'blufin'
+
+App::execute

data/lib/blufin.rb

@@ -0,0 +1,245 @@
+require 'blufin-lib'
+require 'columnist'
+require 'convoy'
+require 'mysql2'
+require 'yaml'
+
+require_relative 'version'
+require 'core/site/site_services'
+require 'core/yml/yml_validator_base'
+require 'core/yml_writers/yml_writer_base'
+
+Dir["#{File.dirname(__FILE__)}/core/**/*.rb"].each { |file| load(file) unless file =~ /\/(site_services|yml_validator_base|yml_writer_base)\.rb\z/ }
+Dir["#{File.dirname(__FILE__)}/routes/**/*.rb"].each { |file| load(file) }
+
+module App
+
+    GEM_NAME = 'blufin'
+    SCHEMA_FILE = "#{App::Opt::get_base_path}#{App::Opt::OPT_PATH}/config/schema.yml"
+    TEMPLATE_FILE = "#{App::Opt::get_base_path}#{App::Opt::OPT_PATH}/config/template.yml"
+    CONFIG_FILE   = '~/.blufin.yml'
+
+    def self.execute
+
+        begin
+
+            unless ARGV[0] == 'setup' || ARGV[0] == 'x'
+                Blufin::Config::init(SCHEMA_FILE, TEMPLATE_FILE, App::CONFIG_FILE, App::GEM_NAME)
+                Blufin::Projects::init(Blufin::Config::get, App::CONFIG_FILE)
+            end
+
+            Convoy::App.create do |app|
+
+                # http://patorjk.com/software/taag/#p=display&f=ANSI%20Shadow&t=Blufin
+                app.version BLUFIN_VERSION
+                app.summary <<TEMPLATE
+ \x1B[48;5;20m\x1B[38;5;255m Blufin \x1B[0m\x1B[0m \x1B[38;5;32m\xe2\x80\x94 Command-Line Interface \xe2\x80\x94\x1B[38;5;248m 🐳 
+
+
+    ██████╗ ██╗     ██╗   ██╗███████╗██╗███╗   ██╗
+    ██╔══██╗██║     ██║   ██║██╔════╝██║████╗  ██║
+    ██████╔╝██║     ██║   ██║█████╗  ██║██╔██╗ ██║
+    ██╔══██╗██║     ██║   ██║██╔══╝  ██║██║╚██╗██║
+    ██████╔╝███████╗╚██████╔╝██║     ██║██║ ╚████║
+    ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝     ╚═╝╚═╝  ╚═══╝\x1B[0m
+TEMPLATE
+                app.description "The secret sauce that makes everything 'tick'..."
+
+                # b - BUILD
+                app.command :build, :aliases => [:b] do |build|
+                    build.summary "Build #{Blufin::Terminal::format_highlight('project-specific')} java services #{Blufin::Terminal::format_invalid('@deprecated')}"
+                    build.options do |opts|
+                        opts.opt :skip_tests, 'Skip tests', :short => '-S', :long => '--skip', :type => :boolean
+                    end
+                    build.action do |opts, args|
+                        AppCommand::Build.new(opts, args).execute
+                    end
+                end
+
+                # c - CREATE
+                app.command :create, :aliases => [:c] do |create|
+                    create.summary 'Create skeleton project from archetype(s)'
+                    # a - CREATE API
+                    create.command :api, :aliases => [:a] do |create_api|
+                        create_api.summary 'Create API skeleton'
+                        create_api.action do |opts, args|
+                            AppCommand::CreateApi.new(opts, args).execute
+                        end
+                    end
+                    # u - CREATE UI
+                    create.command :ui, :aliases => [:u] do |create_ui|
+                        create_ui.summary 'Create UI skeleton'
+                        create_ui.action do |opts, args|
+                            AppCommand::CreateUI.new(opts, args).execute
+                        end
+                    end
+                    # CREATE (Default)
+                    create.action do
+                        system("#{App::GEM_NAME} c -h")
+                    end
+                end
+
+                # e - EXPORT
+                app.command :export, :aliases => [:e] do |export|
+                    export.summary 'Export internal data structures'
+                    export.options do |opts|
+                        opts.opt :maven_blufin, 'Maven BOM (Blufin)', :short => '-m', :long => '--maven-blufin', :type => :boolean
+                        opts.opt :maven_app, 'Maven BOM (App)', :short => '-M', :long => '--maven-app', :type => :boolean
+                    end
+                    export.action do |opts, args|
+                        AppCommand::Export.new(opts, args).execute
+                    end
+                end
+
+                # g - GENERATE
+                app.command :generate, :aliases => [:g] do |generate|
+                    generate.summary "Generate #{Blufin::Terminal::format_highlight('code')} (and other things)"
+                    # a - GENERATE API
+                    generate.command :api, :aliases => [:a] do |generate_api|
+                        generate_api.summary 'Generate boiler-plate API code (from YML files)'
+                        generate_api.action do |opts, args|
+                            AppCommand::GenerateApi.new(opts, args).execute
+                        end
+                    end
+                    # l - GENERATE LAMBDA
+                    generate.command :lambda, :aliases => [:l] do |generate_lambda|
+                        generate_lambda.summary 'Generate boiler-plate AWS Lambda code'
+                        generate_lambda.action do |opts, args|
+                            AppCommand::GenerateLambda.new(opts, args).execute
+                        end
+                    end
+                    # generate - GENERATE UI
+                    generate.command :ui, :aliases => [:u] do |generate_ui|
+                        generate_ui.summary 'Generate UI stuff'
+                        # a - GENERATE UI LANDING PAGE
+                        generate_ui.command :img_landing, :aliases => [:l] do |generate_ui_img_landing|
+                            generate_ui_img_landing.summary 'Generate different landing page image sizes'
+                            generate_ui_img_landing.options do |opts|
+                                opts.opt :add_size, 'Add image size (in top-left corner)', :short => '-s', :long => '--add-size', :type => :boolean
+                                opts.opt :quality, 'Quality of the image (default: 60)', :short => '-q', :long => '--quality', :type => :string, :default => '60'
+                                opts.opt :skip_confirm, 'Skip confirmation', :short => '-y', :long => '--skip-confirm', :type => :boolean
+                            end
+                            generate_ui_img_landing.action do |opts, args|
+                                AppCommand::GenerateUIImageLanding.new(opts, args).execute
+                            end
+                        end
+                        # a - GENERATE UI FAVICON
+                        generate_ui.command :img_favicon, :aliases => [:f] do |generate_ui_img_favicon|
+                            generate_ui_img_favicon.summary 'Generate favicon.ico file'
+                            generate_ui_img_favicon.action do |opts, args|
+                                AppCommand::GenerateUIFavIcon.new(opts, args).execute
+                            end
+                        end
+                        # GENERATE UI (Default)
+                        generate_ui.action do
+                            system("#{App::GEM_NAME} g ui -h")
+                        end
+                    end
+                    # GENERATE (Default)
+                    generate.action do
+                        system("#{App::GEM_NAME} g -h")
+                    end
+                end
+
+                # l - LINT
+                app.command :lint, :aliases => [:l] do |lint|
+                    lint.summary "Scans code for errors/anti-patterns #{Blufin::Terminal::format_invalid('@todo')}"
+                    lint.action do |opts, args|
+                        AppCommand::Lint.new(opts, args).execute
+                    end
+                end
+
+                # M - MYSQL
+                app.command :mysql, :aliases => [:M] do |mysql|
+                    mysql.summary 'Manage development databases (and mock data)'
+                    # r - MYSQL RESET
+                    mysql.command :reset, :aliases => [:r] do |mysql_reset|
+                        mysql_reset.summary 'Reset development databases to a standard configuration'
+                        mysql_reset.options do |opts|
+                            opts.opt :skip_confirm, 'Skip confirmation (a safety measure to prevent accidental reset)', :short => '-y', :long => '--skip-confirm', :type => :boolean
+                            opts.opt :verbose, 'Verbose', :short => '-v', :long => '--verbose', :type => :boolean
+                        end
+                        mysql_reset.action do |opts, args|
+                            AppCommand::MySQLReset.new(opts, args).execute
+                        end
+                    end
+                    # MYSQL (Default)
+                    mysql.action do
+                        system("#{App::GEM_NAME} M -h")
+                    end
+                end
+
+                # r - RUN
+                app.command :run, :aliases => [:r] do |run|
+                    run.summary "Run a project/service #{Blufin::Terminal::format_invalid('@todo')}"
+                    run.action do |opts, args|
+                        AppCommand::Run.new(opts, args).execute
+                    end
+                end
+
+                # R - RELEASE
+                # TODO - This might need to be behind some-kind of toggle so devs can't just release blufin, willy-nilly.
+                app.command :release, :aliases => [:R] do |release|
+                    release.summary 'Create & deploy new releases'
+                    # b - RELEASE BLUFIN
+                    release.command :blufin, :aliases => [:b] do |release_blufin|
+                        release_blufin.summary 'Create and deploy the latest version of Blufin (along with all the gems, lambdas, etc.)'
+                        release_blufin.action do |opts, args|
+                            AppCommand::ReleaseBlufin.new(opts, args).execute
+                        end
+                    end
+                    # RELEASE (Default)
+                    release.action do
+                        system("#{App::GEM_NAME} R -h")
+                    end
+                end
+
+                # p - PROJECT
+                app.command :project, :aliases => [:p] do |project|
+                    project.summary 'Information about Projects'
+                    # al - PROJECT API LIST
+                    project.command :api_list, :aliases => [:al] do |project_api_list|
+                        project_api_list.summary 'List all APIs'
+                        project_api_list.action do |opts, args|
+                            AppCommand::APIList.new(opts, args).execute
+                        end
+                    end
+                    # am - PROJECT API META
+                    project.command :api_meta, :aliases => [:am] do |project_api_meta|
+                        project_api_meta.summary 'Display various meta-data about an API'
+                        project_api_meta.options do |opts|
+                            opts.opt :show_auto_increment, "Show #{Blufin::Terminal::format_highlight('AUTO_INCREMENT')} columns", :short => '-a', :long => '--show-auto-increment', :type => :boolean
+                            opts.opt :show_enums, "Show all available #{Blufin::Terminal::format_highlight('ENUMs')} (and their values)", :short => '-e', :long => '--show-enums', :type => :boolean
+                            opts.opt :show_resources, "Show #{Blufin::Terminal::format_highlight('RESOURCE')} structure #{Blufin::Terminal::format_invalid('@deprecated')}", :short => '-r', :long => '--show-resources', :type => :boolean
+                            opts.opt :as_json, 'Return meta-data as JSON (might not work for all paths)', :short => '-J', :long => '--as-json', :type => :boolean
+                        end
+                        project_api_meta.action do |opts, args|
+                            AppCommand::APIMeta.new(opts, args).execute
+                        end
+                    end
+                    # PROJECT (Default)
+                    project.action do
+                        system("#{App::GEM_NAME} p -h")
+                    end
+                end
+
+                # x - CONFIG
+                app.command :config, :aliases => [:x] do |config|
+                    config.summary 'Setup your configuration file'
+                    config.action do
+                        Blufin::Config::edit_config(App::CONFIG_FILE)
+                    end
+                end
+
+                # BLUFIN (Default)
+                app.action do
+                    system("#{App::GEM_NAME} -h")
+                end
+            end
+
+        rescue RuntimeError => e
+
+            Blufin::Terminal::print_exception(e);
+        end
+    end
+end

data/lib/core/code_scanners/common/scanner_common.rb

@@ -0,0 +1,83 @@
+module Blufin
+
+    class ScannerCommon
+
+        # Gets all non-ignored files in a specific directory (recursively).
+        #      path = the path from root, IE: /Users/Albert/Repos/repos-blufin/[site-name]/app-infrastructure
+        # gitignore = the path (prefix) to ignore as defined in .gitignore, IE: app-infrastructure
+        # @return Array (of files)
+        def self.get_non_ignored_files(path, extensions, error_handler, gitignore_path = nil)
+            raise RuntimeError, "Expected String, instead got: #{path.class}" unless path.is_a?(String)
+            raise RuntimeError, "Expected Array, instead got: #{extensions.class}" unless extensions.is_a?(Array)
+            raise RuntimeError, "Expected YmlErrorHandler, instead got:#{error_handler.class}" unless error_handler.is_a?(Blufin::YmlErrorHandler)
+            raise RuntimeError, "Expected String or Nil, instead got: #{gitignore_path.class}" unless gitignore_path.nil? || gitignore_path.is_a?(String)
+            found_files  = []
+            ignore_paths = []
+            scan_path    = path
+            gitignore_path.gsub(/\A\//, '').gsub(/\/\z/, '') unless gitignore_path.nil?
+            unless gitignore_path.nil? || gitignore_path == ''
+                gitignore_file = "#{path}/.gitignore"
+                scan_path      = "#{path}/#{gitignore_path}"
+                if Blufin::Files::file_exists(gitignore_file)
+                    # Adds all ignore paths for .gitignore.
+                    Blufin::Files::read_file(gitignore_file).each do |line|
+                        line = line.gsub(/\A\//, '').gsub("\n", '')
+                        next unless line =~ /\A#{gitignore_path}\//
+                        ignore_paths << "#{path}/#{line}"
+                    end
+                else
+                    # Add error if git ignore is missing.
+                    error_handler.add_error(Blufin::YmlErrorHandler::FILE_NOT_FOUND_GITIGNORE, gitignore_file, nil, nil, gitignore_file)
+                    return found_files
+                end
+            end
+            # Gets all files (which are not ignored).
+            Blufin::Files::get_files_in_dir("#{scan_path}").each do |file|
+                next if is_in_ignore_path(file, ignore_paths)
+                matches_extension = false
+                extensions.each { |extension| matches_extension = true if file =~ /\.#{extension}\z/ }
+                next unless matches_extension
+                found_files << file
+            end
+            found_files
+        end
+
+        # Takes a path and swaps it from classpath to test-path.
+        # @return String
+        def self.swap_classpath_for_testpath(site, file)
+            raise RuntimeError, "Expected String, instead got: #{file.class}" unless file.is_a?(String)
+            site             = Blufin::SiteResolver::validate_site(site)
+            site_name        = Blufin::SiteResolver::get_site_name(site)
+            site_domain      = Blufin::SiteResolver::get_site_domain(site)
+            site_domain_gsub = site_domain.strip == '' ? '' : "#{site_domain.gsub('.', '/')}\\/"
+            begin
+                matches   = file.match(/\/#{site_name}-(#{Blufin::SiteServices::REGEX_JAVA})\/src\/main\/java\/#{site_domain_gsub}#{site_name.gsub('-', '/')}\//)
+                matches   = matches[0].gsub(/\A\//, '').gsub(/\/\z/, '')
+                matches   = matches.split('/')
+                service   = matches[0]
+                swap_path = "/#{service}/src/main/java/"
+                swap_for  = "/#{service}/src/test/java/"
+                raise RuntimeError, "Unable to find swap_path: #{swap_path}" unless file =~ /#{swap_path}/
+                return file.gsub(swap_path, swap_for)
+            rescue => e
+                puts e.message
+                raise RuntimeError, "Failed to swap_classpath_for_testpath() with file: #{file}"
+            end
+        end
+
+        private
+
+        # Checks if file is in ignore_paths Array. Only used internally by this class.
+        # @return Boolean
+        def self.is_in_ignore_path(file, ignore_paths)
+            ignore_paths.each { |line|
+                line = line.gsub(/\*\*\/\*\z/, '')
+                line = line.gsub(/\*\*\//, '')
+                line = line.gsub(/\*\z/, '')
+                return true if file.strip =~ /\A#{line.strip}/ }
+            false
+        end
+
+    end
+
+end

data/lib/core/code_scanners/common/scanner_java.rb

@@ -0,0 +1,106 @@
+module Blufin
+
+    class ScannerJava
+
+        NAME = 'name'
+        PATH = 'path'
+
+        TEST                      = 'test'
+        TEST_REQUIRED             = 'test_required'
+        TEST_NOT_RELATED_TO_CLASS = 'test_not_related_to_class'
+
+        TYPE                = 'type'
+        TYPE_CLASS          = 'type_class'
+        TYPE_CLASS_ABSTRACT = 'type_class_abstract'
+        TYPE_ENUM           = 'type_enum'
+        TYPE_INTERFACE      = 'type_interface'
+
+        @@scanned_classes = {}
+
+        # Returns a Hash containing info about the Java class.
+        # @return void
+        def self.scan(file, site, error_handler)
+            return @@scanned_classes[file] unless @@scanned_classes[file].nil?
+            raise RuntimeError, "Expected String, instead got: #{file.class}" unless file.is_a?(String)
+            raise RuntimeError, "This method only accepts .java files. You passed: #{file}" unless file =~ /\.java\z/
+            site      = Blufin::SiteResolver::validate_site(site)
+            site_path = Blufin::SiteResolver::get_site_location(site)
+            fps       = Blufin::YmlCommon::split_to_path_file(file, site_path)
+            info      = {
+                NAME => fps[1],
+                PATH => fps[0],
+            }
+
+            # Is this a test?
+            info[TEST]          = (file =~ /\/src\/test\//) ? true : false
+            info[TEST_REQUIRED] = true unless info[TEST]
+
+            @test_required             = false
+            @test_not_required         = false
+            @test_not_related_to_class = false
+
+            Blufin::Files::read_file(file).each do |line|
+                get_java_class_type(info, line, file) if info[TYPE].nil?
+                get_java_test_required(info, line) if info[TEST_REQUIRED]
+                get_java_test_not_related_to_class(info, line) if info[TEST]
+            end
+
+            # Errors
+            tests_annotations_found = []
+            tests_annotations_found << Blufin::SiteServices::ANNOTATION_TEST_REQUIRED if @test_required
+            tests_annotations_found << Blufin::SiteServices::ANNOTATION_TEST_NOT_REQUIRED if @test_not_required
+            error_handler.add_error(Blufin::YmlErrorHandler::ANNOTATIONS_ONE_OR_ANOTHER, file, nil, nil, [Blufin::SiteServices::ANNOTATION_TEST_REQUIRED, Blufin::SiteServices::ANNOTATION_TEST_NOT_REQUIRED].inspect) if @test_required && @test_not_required
+            error_handler.add_error(Blufin::YmlErrorHandler::ANNOTATIONS_NOT_EXPECTED, file, nil, nil, tests_annotations_found.inspect) if info[TEST] && tests_annotations_found.any?
+            error_handler.add_error(Blufin::YmlErrorHandler::ANNOTATIONS_NOT_EXPECTED, file, nil, nil, Blufin::SiteServices::ANNOTATION_TEST_NOT_RELATED_TO_CLASS.inspect) if info[TEST] == false && @test_not_related_to_class
+            info[TEST_REQUIRED] = true if @test_required
+            info[TEST_REQUIRED] = false if @test_not_required
+            raise RuntimeError, "Unrecognized ClassType: #{file}" if info[TYPE].nil?
+            @@scanned_classes[file] = info
+            info
+        end
+
+        private
+
+        # Gets the Java class TYPE.
+        # @return void
+        def self.get_java_class_type(info, line, file)
+            if line =~ /\Apublic class\s/ || line =~ /\Apublic final class\s/
+                info[TYPE] = TYPE_CLASS
+            elsif line =~ /\Aclass\s/ || line =~ /\Afinal class\s/
+                info[TYPE] = TYPE_CLASS
+                # TODO - 05-06-19 - Remove this warning once we have some kind of code-formatter.
+                Blufin::Terminal::output("Class in file is not public: #{file}", Blufin::Terminal::MSG_WARNING)
+            elsif line =~ /\Apublic abstract class/
+                info[TYPE] = TYPE_CLASS_ABSTRACT
+            elsif line =~ /\Apublic enum/
+                info[TYPE] = TYPE_ENUM
+            elsif line =~ /\Apublic interface/
+                info[TYPE] = TYPE_INTERFACE
+            end
+        end
+
+        # Looks for @TestRequired, @NoTestRequired annotation.
+        # @return void
+        def self.get_java_test_required(info, line)
+            return if (@test_required || @test_not_required) && !info[TYPE].nil?
+            info[TEST_REQUIRED] = false if line =~ /\A#{Blufin::SiteServices::ANNOTATION_TEST_NOT_REQUIRED}/
+            info[TEST_REQUIRED] = false if line =~ /\Apublic abstract class/
+            @test_required      = true if line =~ /\A#{Blufin::SiteServices::ANNOTATION_TEST_REQUIRED}/
+            @test_not_required  = true if line =~ /\A#{Blufin::SiteServices::ANNOTATION_TEST_NOT_REQUIRED}/
+        end
+
+        # Looks for @TestNotRelatedToClass annotation.
+        # @return void
+        def self.get_java_test_not_related_to_class(info, line)
+            return if info[TEST_NOT_RELATED_TO_CLASS]
+            if line =~ /\A#{Blufin::SiteServices::ANNOTATION_TEST_NOT_RELATED_TO_CLASS}/
+                info[TEST_NOT_RELATED_TO_CLASS] = true
+                @test_not_related_to_class      = true
+            else
+                info[TEST_NOT_RELATED_TO_CLASS] = false
+            end
+        end
+
+    end
+
+end