eworld 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75950a16fbe8126fcd439351997bf68c4d912f67
-  data.tar.gz: fe5d72a612293037e4667379eea1a4be21f750ef
+  metadata.gz: '078008fd3dd291e33389b27aa315baf2e685e058'
+  data.tar.gz: c60c14e788eead8fce813927566c3d3fbb6e698d
 SHA512:
-  metadata.gz: 5176d9ea6e1f28b299b26f380f00d412282eb617e6e9ca998b0c8d1a8f7eccd09bb482aad5e4d4725ecb7dbb50adcfbb92127c25ce8e8e35b29f46c77a9011fa
-  data.tar.gz: 4fd6382b37596917e580333ceaec8f52d45a8733d70df92b44b87de6545bff708a7a92b03328009fa999d9cb2bf4c6a65d3f130bf2e487442028046683c68bad
+  metadata.gz: e94582312d862b1604f9b34ec7cc6a82691ff22bf610ddb008d5f323adad8ff750fdf304cbdbba9b6b542986195db1fe3dfd9fc4a87ff052582287ee5505b652
+  data.tar.gz: 6923c41a9ab7945198a4b93eab25b9db09e6269df1c5f776427fef85ea5b521134e3eba4ae968c95b9fd1b97a931b3ed039ef5c0d69b604f754e9030937e7d3d

data/lib/core/aws_profile.rb

@@ -0,0 +1,41 @@
+module App
+
+    class AWSProfile
+
+        @@profile     = nil
+        @@credentials = nil
+
+        # Reads the config data and attempts to extract the profile.
+        # @return void
+        def self.init(config_data)
+
+            errors                     = []
+
+            # Get the profile out of the config YML.
+            @@profile                  = config_data['AWS']['Profile'] if config_data.has_key?('AWS')
+
+            # Check the credentials exist.
+            @@credentials, more_errors = Blufin::AWS::get_aws_credentials(@@profile)
+            errors.concat(more_errors)
+
+            # If anything is wrong, output error(s).
+            Blufin::Config::invalid_configuration(App::GEM_NAME, errors) if errors.any?
+
+        end
+
+        # Get the AWS profile. Returns either the profile (or nil).
+        # @return string
+        def self.get
+            @@profile
+        end
+
+        # Convenience method to just get the profile name.
+        # @return string
+        def self.get_profile_name
+            return nil if @@credentials.nil?
+            @@profile[PROFILE]
+        end
+
+    end
+
+end

data/lib/eworld.rb

@@ -2,11 +2,16 @@ require 'blufin-lib'
 require 'columnist'
 require 'convoy'
 require 'yaml'
+require 'json'
+
 require_relative 'version'
+require 'writers/base_writer'
 
 Dir["#{File.dirname(__FILE__)}/core/**/*.rb"].each { |file| load(file) }
 Dir["#{File.dirname(__FILE__)}/routes/**/*.rb"].each { |file| load(file) }
 Dir["#{File.dirname(__FILE__)}/rules/**/*.rb"].each { |file| load(file) }
+Dir["#{File.dirname(__FILE__)}/scanners/**/*.rb"].each { |file| load(file) }
+Dir["#{File.dirname(__FILE__)}/writers/**/*.rb"].each { |file| load(file) unless file =~ /\/(base_writer)\.rb\z/ }
 
 module App
 
@@ -22,7 +27,8 @@ module App
 
             unless ARGV[0] == 'config' || ARGV[0] == 'x'
                 Blufin::Config::init(SCHEMA_FILE, TEMPLATE_FILE, CONFIG_FILE, GEM_NAME)
-                Blufin::Projects.new(Blufin::Config::get['Projects'])
+                App::AWSProfile::init(Blufin::Config::get)
+                Blufin::Projects.new(Blufin::Config::get['Projects'], App::AWSProfile::get)
             end
 
             Convoy::App.create do |app|
@@ -43,39 +49,11 @@ TEMPLATE
                 if is_albert_mac
                     app.command :generate, :aliases => [:g] do |generate|
                         generate.summary 'Generate boiler-plate code'
-                        # a - GENERATE API
-                        generate.command :api, :aliases => [:a] do |generate_api|
-                            generate_api.summary 'Generate API code'
-                            # e - GENERATE API ENTITIES
-                            generate_api.command :api_entities, :aliases => [:e] do |generate_api_entities|
-                                generate_api_entities.summary 'Generate boiler-plate entity code'
-                                generate_api_entities.action do |opts, args|
-                                    AppCommand::GenerateApiEntities.new(opts, args).execute
-                                end
-                            end
-                            # GENERATE API (Default)
-                            generate_api.action do
-                                system("#{App::GEM_NAME} g a -h")
-                            end
-                        end
-                        # generate - GENERATE UI
-                        generate.command :ui, :aliases => [:u] do |generate_ui|
-                            generate_ui.summary 'Generate UI code'
-                            # r - GENERATE UI ROUTES
-                            generate_ui.command :ui_routes, :aliases => [:r] do |generate_ui_routes|
-                                generate_ui_routes.summary 'Generate routes.js (and blank routes if not exists)'
-                                generate_ui_routes.action do |opts, args|
-                                    AppCommand::GenerateUiRoutes.new(opts, args).execute
-                                end
-                            end
-                            # GENERATE UI (Default)
-                            generate_ui.action do
-                                system("#{App::GEM_NAME} g u -h")
-                            end
+                        generate.options do |opts|
+                            opts.opt :silent, 'Run in silent mode', :short => '-s', :long => '--silent', :type => :boolean
                         end
-                        # GENERATE (Default)
-                        generate.action do
-                            system("#{App::GEM_NAME} g -h")
+                        generate.action do |opts, args|
+                            AppCommand::Generate.new(opts, args).execute
                         end
                     end
                 end

data/lib/routes/generate.rb

@@ -0,0 +1,127 @@
+module AppCommand
+
+    class Generate < ::Convoy::ActionCommand::Base
+
+        def execute
+
+            begin
+
+                @opts = command_options
+                @args = arguments
+
+                @verbose = !@opts[:silent]
+
+                @errors      = []
+                @generated   = []
+                @overwritten = []
+
+                opts_validate
+                opts_routing
+
+            rescue => e
+
+                Blufin::Terminal::print_exception(e)
+
+            end
+
+        end
+
+        def opts_validate
+
+            # TODO - This cannot be hard-coded forever!
+            group = 'fmm'
+
+            # Get API Project.
+            api_projects = Blufin::Projects.get_projects_as_array(group: group, types: [Blufin::Projects::TYPE_API_SIMPLE])
+            @api_project = Blufin::Projects.show_project_prompt(api_projects)
+
+            # Get Quasar Project.
+            ui_projects = Blufin::Projects.get_projects_as_array(group: group, types: [Blufin::Projects::TYPE_QUASAR])
+            @ui_project = Blufin::Projects.show_project_prompt(ui_projects)
+
+            # Get project path(s).
+            @project_path    = Blufin::Projects::get_project_path(@api_project[Blufin::Projects::PROJECT_ID])
+            @project_path_ui = Blufin::Projects::get_project_path(@ui_project[Blufin::Projects::PROJECT_ID], true)
+
+            puts if @verbose
+
+            td   = @ui_project[Blufin::Projects::TRANSIENT_DATA]
+            root = Blufin::Strings::remove_surrounding_slashes(td[Blufin::Projects::CG_QUASAR_ROOT])
+            js   = Blufin::Strings::remove_surrounding_slashes(td[Blufin::Projects::CG_QUASAR_JS])
+
+            Blufin::Terminal::execute_proc("Scanning: #{Blufin::Terminal::format_highlight('Javascript')}", Proc.new {
+                eb      = @errors.length
+                @js, je = Blufin::ScannerJs::scan("#{@project_path}/#{root}/#{js}")
+                @errors.concat(je)
+                eb == @errors.length
+            }, verbose: @verbose)
+
+            Blufin::Terminal::execute_proc("Scanning: #{Blufin::Terminal::format_highlight('Routes')}", Proc.new {
+                eb                   = @errors.length
+                @routes_to_write, re = EWorld::RouteScanner::scan(@ui_project)
+                @errors.concat(re)
+                eb == @errors.length
+            }, verbose: @verbose)
+
+            Blufin::Terminal::execute_proc("Scanning: #{Blufin::Terminal::format_highlight('Controllers')}", Proc.new {
+                eb               = @errors.length
+                @controllers, ce = EWorld::ControllerScanner::scan(@api_project)
+                @errors.concat(ce)
+                eb == @errors.length
+            }, verbose: @verbose)
+
+            puts if @errors.any? && @verbose
+
+            Blufin::ScannerError::output_cli(@errors, false) if @errors.any?
+
+        end
+
+        def opts_routing
+
+            Blufin::Terminal::execute_proc("Processing: #{Blufin::Terminal::format_highlight('Routes')}", Proc.new {
+                rg, ro = EWorld::RouteWriter::write(@ui_project, @routes_to_write)
+                @generated.concat(rg)
+                @overwritten.concat(ro)
+            }, verbose: @verbose)
+
+            Blufin::Terminal::execute_proc("Processing: #{Blufin::Terminal::format_highlight('Controllers')}", Proc.new {
+                cg, co = EWorld::ControllerWriter::write(@api_project, @ui_project, @controllers)
+                @generated.concat(cg)
+                @overwritten.concat(co)
+
+            }, verbose: @verbose)
+
+            Blufin::Terminal::execute_proc("Processing: #{Blufin::Terminal::format_highlight('Services')}", Proc.new {
+                sg, so = EWorld::ServiceWriter::write(@api_project, @ui_project, @controllers)
+                @generated.concat(sg)
+                @overwritten.concat(so)
+            }, verbose: @verbose)
+
+            Blufin::Terminal::execute_proc("Processing: #{Blufin::Terminal::format_highlight('API Docs (JSON)')}", Proc.new {
+                ag, ao = EWorld::ApiDocsWriter::write(@api_project, @ui_project, @controllers)
+                @generated.concat(ag)
+                @overwritten.concat(ao)
+            }, verbose: @verbose)
+
+            Blufin::Terminal::execute_proc("Processing: #{Blufin::Terminal::format_highlight('JS Docs (JSON)')}", Proc.new {
+                jg, jo = EWorld::JsDocsWriter::write(@api_project, @ui_project, @js)
+                @generated.concat(jg)
+                @overwritten.concat(jo)
+            }, verbose: @verbose)
+
+            # Reformat front-end.
+            Blufin::Terminal::execute_proc('Re-formatting UI codebase', Proc.new {
+                Blufin::Terminal::execute('git add .', @project_path_ui, verbose: false)
+                Blufin::Terminal::execute('yarn format', @project_path_ui, verbose: false)
+            }, verbose: @verbose)
+
+            puts if @verbose && !@generated.any? && !@overwritten.any?
+
+            Blufin::Terminal::custom('Generated', 22, 'The following files were generated:', @generated) if @generated.any?
+            Blufin::Terminal::custom('Overwritten', 55, 'The following files were overwritten:', @overwritten) if @overwritten.any?
+
+        end
+
+    end
+
+end

data/lib/routes/scan.rb

@@ -27,15 +27,51 @@ module AppCommand
         def opts_routing
 
             # TODO - This cannot be hard-coded forever!
-            project = 'fmm'
-
-            @results = Blufin::Scanner::scan(project)
-            @errors  = @results[:errors]
+            group = 'fmm'
+
+            @errors = []
+            @js     = nil
+            @java   = nil
+
+            Blufin::Projects::get_projects_as_array.each do |project|
+                if project[Blufin::Projects::PROJECT] == group
+                    project_id         = project[Blufin::Projects::PROJECT_ID]
+                    project_type       = project[Blufin::Projects::TYPE]
+                    project_path       = Blufin::Projects::get_project_path(project_id)
+                    project_path_inner = Blufin::Projects::get_project_path(project_id, true)
+                    case project_type
+                        when Blufin::Projects::TYPE_API_SIMPLE
+                            raise RuntimeError, "Project with type: #{Blufin::Projects::TYPE_API_SIMPLE} already scanned." unless @java.nil?
+                            @java, errors_java = Blufin::ScannerJava::scan("#{project_path_inner}")
+                            @errors.concat(errors_java)
+                        when Blufin::Projects::TYPE_QUASAR
+                            raise RuntimeError, "Project with type: #{Blufin::Projects::TYPE_QUASAR} already scanned." unless @s.nil?
+                            # Scan the routes.
+                            @routes, errors_routes = EWorld::RouteScanner::scan(project)
+                            @errors.concat(errors_routes)
+                            # Extract JS data.
+                            td   = project[Blufin::Projects::TRANSIENT_DATA]
+                            root = Blufin::Strings::remove_surrounding_slashes(td[Blufin::Projects::CG_QUASAR_ROOT])
+                            js   = Blufin::Strings::remove_surrounding_slashes(td[Blufin::Projects::CG_QUASAR_JS])
+                            jst  = Blufin::Strings::remove_surrounding_slashes(td[Blufin::Projects::CG_QUASAR_TESTS])
+                            if project.has_key?(Blufin::Projects::TRANSIENT_DATA) && td.has_key?(Blufin::Projects::CG_QUASAR_JS)
+                                @js, errors_js             = Blufin::ScannerJs::scan("#{project_path}/#{root}/#{js}")
+                                @js_tests, errors_js_tests = Blufin::ScannerJsTests::scan("#{project_path}/#{root}/#{jst}")
+                                @vue, errors_vue           = Blufin::ScannerVue::scan("#{project_path}/#{root}")
+                                @errors.concat(errors_js)
+                                @errors.concat(errors_js_tests)
+                                @errors.concat(errors_vue)
+                            end
+                        else
+                            raise RuntimeError, "Unsupported project type: #{project_type}"
+                    end
+                end
+            end
 
-            run_js_rules(@results[:js_data]) unless @results[:js_data].nil?
+            run_js_rules(@js) unless @js.nil?
 
             # Output Errors (if any).
-            Blufin::ScannerError::output_cli(@errors) if @errors.any?
+            Blufin::ScannerError::output_cli(@errors)
 
         end
 

data/lib/rules/js/rule_js_parameters.rb

@@ -2,7 +2,6 @@ module EWorld
 
     class RuleJsParameters
 
-
         # This rule validate JS method parameters.
         # It checks that the parameters match the actual methods and that we have a description/return type.
         # @return Array (of errors)
@@ -34,7 +33,7 @@ module EWorld
                     actual   = method_data[:docs][:params].keys
 
                     # Throw error if params don't match comments.
-                    raise RuntimeError, "Params docs (for #{method_name}) are missing or don't match." if expected.to_s != actual.to_s
+                    raise RuntimeError, "#{method_name} \xe2\x80\x94 Param docs are missing, corrupted or incorrect." if expected.to_s != actual.to_s
 
                     # Make sure we have all the comment doc stuff we need.
                     if method_data[:docs].is_a?(Hash)

data/lib/scanners/controller_scanner.rb

@@ -0,0 +1,137 @@
+module EWorld
+
+    class ControllerScanner
+
+        SCHEMA_FILE = "#{EWorld::Opt::get_base_path}#{EWorld::Opt::OPT_PATH}/schema/controllers.yml"
+
+        # Responsible for scanning the .codegen/controllers/[MULTIPLE].yml file(s).
+        # @return Array
+        def self.scan(api_project)
+
+            # TODO - Need to inject permissions.
+            # TODO - Need to inject entities.
+
+            raise RuntimeError, "Expected project type to be: #{Blufin::Projects::TYPE_API_SIMPLE}, instead got: #{api_project[Blufin::Projects::TYPE]}" unless api_project[Blufin::Projects::TYPE] == Blufin::Projects::TYPE_API_SIMPLE
+            @errors       = []
+            @controllers  = {}
+            @classes_seen = []
+            @paths_seen   = []
+            begin
+                @project_path          = Blufin::Projects::get_project_path(api_project[Blufin::Projects::PROJECT_ID])
+                @project_path_api      = Blufin::Projects::get_project_path(api_project[Blufin::Projects::PROJECT_ID], true)
+                @project_transient_api = api_project[Blufin::Projects::TRANSIENT_DATA]
+                @controller_path       = "#{EWorld::BaseWriter::get_java_path_for(@project_path, @project_transient_api['ControllerPath'])}/#{EWorld::ControllerWriter::PACKAGE_NAME}"
+                @service_path          = "#{EWorld::BaseWriter::get_java_path_for(@project_path, @project_transient_api['ServicePath'])}/#{EWorld::ServiceWriter::PACKAGE_NAME}"
+                controller_yml_path    = "#{@project_path}/.#{Blufin::Projects::CODEGEN}/controllers"
+                # If path not found, bomb-out immediately.
+                unless Blufin::Files::path_exists(controller_yml_path)
+                    @errors << Blufin::ScannerError::add_error(nil, "YML Controller path not found: #{controller_yml_path}")
+                    return @errors, {}
+                end
+                # If the parent path where controllers/services should live doesn't exists -- bomb-out!
+                [@controller_path, @service_path].each do |path|
+                    unless Blufin::Files::path_exists(path)
+                        @errors << Blufin::ScannerError::add_error(nil, "Path not found: #{path}")
+                        return {}, @errors
+                    end
+                end
+                # Loop all the YML files. Each file = 1 controller.
+                Blufin::Files::get_files_in_dir(controller_yml_path).each do |controller_file|
+                    @file       = controller_file
+                    # Get extension + controller root path.
+                    fs          = @file.split('.')
+                    @root_path  = fs[fs.length - 2].split('/')
+                    @root_path  = @root_path[@root_path.length - 1]
+                    @class_name = "#{Blufin::Strings::snake_case_to_camel_case(@root_path.gsub('-', '_'))}"
+                    ext         = fs[fs.length - 1]
+                    # Make sure we don't have duplicate class names.
+                    @errors << Blufin::ScannerError::add_error(@file, "Duplicate class: #{@class_name}") if @classes_seen.include?(@class_name.upcase)
+                    @classes_seen << @class_name.upcase
+                    # Make sure we have validly named YML file(s).
+                    @errors << Blufin::ScannerError::add_error(@file, "Expected extension to be lowercase 'yml', instead got: #{ext}") if ext.downcase != 'yml'
+                    unless ext.downcase == 'yml'
+                        @errors << Blufin::ScannerError::add_error(@file, "Expected extension to be 'yml', instead got: #{ext}")
+                        next
+                    end
+                    controller_yml = Blufin::Yml::read_file(@file, SCHEMA_FILE)
+                    # Validate file. If errors, go to next file.
+                    next unless validate_file(controller_yml)
+                    controller_yml['RootPath'] = Blufin::Strings::remove_surrounding_slashes(@root_path)
+                    @controllers[@class_name]  = controller_yml
+                end
+            rescue => e
+                Blufin::Terminal::print_exception(e)
+            end
+            return @controllers, @errors
+        end
+
+        private
+
+        # Put all validation here. If any errors get added, this method returns FALSE and the loop at the top skips processing.
+        # @return bool
+        def self.validate_file(data)
+            error_count_before = @errors.length
+            if data.has_key?('EndPoints') && data['EndPoints'].is_a?(Array)
+                data['EndPoints'].each do |resource|
+                    path          = resource['Path']
+                    path_full     = "/#{Blufin::Strings::remove_surrounding_slashes(@root_path)}/#{Blufin::Strings::remove_surrounding_slashes(resource['Path'])}"
+                    path_downcase = path_full.downcase
+                    method        = resource['Method']
+                    path_method   = "#{method} #{path_downcase}"
+                    prefix        = "#{path_full} \xe2\x80\x94 "
+                    # Make sure path does not have trailing/preceding slashes.
+                    @errors << Blufin::ScannerError::add_error(@file, "#{prefix}Path should not have trailing/preceding slash(es): #{path}") if path =~ /^\// || path =~ /\/$/
+                    # Make sure paths are always lowercase.
+                    @errors << Blufin::ScannerError::add_error(@file, "#{prefix}Path(s) must be lowercase, found: #{path_full}") if path_full != path_downcase
+                    path_full.downcase!
+                    # Make sure there are no duplicate permissions.
+                    if resource.has_key?('Permissions')
+                        perms = []
+                        resource['Permissions'].each do |perm|
+                            if perms.include?(perm)
+                                @errors << Blufin::ScannerError::add_error(@file, "#{prefix}Duplicate permission(s): #{perm}")
+                                next
+                            end
+                            perms << perm
+                        end
+                    end
+                    # Make sure we don't have duplicate paths.
+                    @errors << Blufin::ScannerError::add_error(@file, "Duplicate end-point: #{path_method}") if @paths_seen.include?(path_method)
+                    @paths_seen << path_method
+
+                    if %w(POST PUT).include?(method)
+
+                        # TODO NOW - Validate POST/PUT stuff.
+
+                    end
+
+                    # TODO NOW - Validate Service/Method exists.
+                    # TODO NOW - Validate Request Params match service method.
+                    # TODO NOW - What about abstract controller calls for entities?
+
+                end
+            end
+
+            service_file = "#{@service_path}/#{@class_name}Service.java"
+            if Blufin::Files::file_exists(service_file)
+
+                # TODO - Must scan file here ...
+
+                java_data, errors = Blufin::ScannerJava::scan_file(service_file)
+
+                # TODO - REMOVE
+                # puts
+                # puts java_data.to_yaml
+                # puts errors.to_yaml
+
+                @errors.concat(errors)
+
+            end
+
+            # If errors have been added, return FALSE.
+            @errors.length == error_count_before
+        end
+
+    end
+
+end

data/lib/scanners/entity_scanner.rb

@@ -0,0 +1,15 @@
+module EWorld
+
+    class EntityScanner
+
+        # Responsible for scanning the .codegen/entities/[MULTIPLE].yml file.
+        # @return Array
+        def self.scan(project)
+
+            # TODO - Need to inject permissions.
+
+        end
+
+    end
+
+end

data/lib/scanners/permission_scanner.rb

@@ -0,0 +1,15 @@
+module EWorld
+
+    class PermissionScanner
+
+        # Responsible for scanning the .codegen/permissions/permissions.yml file.
+        # @return Array
+        def self.scan(project)
+
+            # TODO NOW - FINISH THIS!
+
+        end
+
+    end
+
+end

data/lib/scanners/queue_scanner.rb

@@ -0,0 +1,15 @@
+module EWorld
+
+    class QueueScanner
+
+        # Responsible for scanning the .codegen/queue/queue.yml file.
+        # @return Array
+        def self.scan(project)
+
+            # TODO NOW - FINISH THIS!
+
+        end
+
+    end
+
+end