eworld 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 879bb0b10067a69b9738caff5862c2d5b62619d6
-  data.tar.gz: 1f4ff588328efd4eff24c665fca21a05f305b724
+  metadata.gz: 2011a169fec8d083f237af3e0e2addf03dae9578
+  data.tar.gz: 16da5f8ecc95470d7684b4f6a33828b55a582739
 SHA512:
-  metadata.gz: 8f373fe9b24e21c171691c24a44926b17b3fb02f3ea540fda7b208de68302e81f80e0f15da252790e0dd54e268691f5a83cdf3e6c9290675104cd22319450589
-  data.tar.gz: 6ddef15e87a5ce36200f500e706348c4a6e79435280bdafab5d5307c2c2c0bf3d94d319cb71f370fe1d6fd8ec12f017a5692c0ac4f66c940824c12496a362704
+  metadata.gz: cf1208be1aa917d58cdf51cc2011268f625feb3a3e14f8fd92571f69f714b30059d0d24b79dbd890ef072dfa2b95c65a8f537a25ca8a7c6ee618a35cda846322
+  data.tar.gz: 5c1714ad25ed5dfce2dba8707bfb8f24ffc0c5be68132730c498dad026a32133c0bac3fcf89ecb62429fef3c7b92c6b90fb724097c24ca9d7084ef06d3b25073

data/lib/eworld.rb

@@ -9,7 +9,6 @@ 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/ }
 
@@ -58,19 +57,6 @@ TEMPLATE
                     end
                 end
 
-                # s - SCAN
-                if is_albert_mac
-                    app.command :scan, :aliases => [:s] do |scan|
-                        scan.summary 'Scan the codebase'
-                        scan.options do |opts|
-                            opts.opt :project, 'Specify Project ID', :short => '-p', :long => '--project', :type => :string
-                        end
-                        scan.action do |opts, args|
-                            AppCommand::Scan.new(opts, args).execute
-                        end
-                    end
-                end
-
                 # U - UPDATE
                 app.command :update, :aliases => [:U] do |update|
                     update.summary 'Check for updates'
@@ -79,6 +65,19 @@ TEMPLATE
                     end
                 end
 
+                # v - VALIDATE
+                if is_albert_mac
+                    app.command :validate, :aliases => [:v] do |validate|
+                        validate.summary 'Valdiate the codebase'
+                        validate.options do |opts|
+                            opts.opt :project, 'Specify Project ID', :short => '-p', :long => '--project', :type => :string
+                        end
+                        validate.action do |opts, args|
+                            AppCommand::Validate.new(opts, args).execute
+                        end
+                    end
+                end
+
                 # x - CONFIG
                 app.command :config, :aliases => [:x] do |config|
                     config.summary 'Setup your configuration file'

data/lib/routes/generate.rb

@@ -45,17 +45,6 @@ module AppCommand
 
             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)
@@ -63,13 +52,6 @@ module AppCommand
                 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?
@@ -84,31 +66,6 @@ module AppCommand
                 @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)

data/lib/routes/{scan.rb → validate.rb}

@@ -1,6 +1,6 @@
 module AppCommand
 
-    class Scan < ::Convoy::ActionCommand::Base
+    class Validate < ::Convoy::ActionCommand::Base
 
         def execute
 
@@ -68,23 +68,11 @@ module AppCommand
                 end
             end
 
-            run_js_rules(@js) unless @js.nil?
-
             # Output Errors (if any).
             Blufin::ScannerError::output_cli(@errors)
 
         end
 
-        private
-
-        # Runs all the rules for the JS files.
-        # @return void
-        def run_js_rules(data)
-
-            @errors = EWorld::RuleJsParameters::run(data, @errors)
-
-        end
-
     end
 
 end

data/lib/scanners/route_scanner.rb

@@ -165,7 +165,7 @@ module EWorld
                 end
 
                 # TODO - If non-tabs, must have FULLPATH, CODE, TITLE
-                # TODO - If tabs, must have ICON, TAB_PARENT
+                # TODO - If tabs, must have ICON, TAB_PARENT (AND TAB PARENT MUST MATCH PARENT).
 
                 expected_name = Blufin::Strings::remove_surrounding_slashes("#{parent_path}/#{child[PATH]}").gsub('/', '-')
                 # Handle special case for dashboard.

data/lib/version.rb

@@ -1 +1 @@
-EWORLD_VERSION = '2.2.2'
+EWORLD_VERSION = '2.3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eworld
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Albert Rannetsperger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blufin-lib
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: columnist
   requirement: !ruby/object:Gem::Requirement
@@ -66,12 +66,7 @@ files:
 - lib/core/opt.rb
 - lib/eworld.rb
 - lib/routes/generate.rb
-- lib/routes/scan.rb
-- lib/rules/js/rule_js_parameters.rb
-- lib/scanners/controller_scanner.rb
-- lib/scanners/entity_scanner.rb
-- lib/scanners/permission_scanner.rb
-- lib/scanners/queue_scanner.rb
+- lib/routes/validate.rb
 - lib/scanners/route_scanner.rb
 - lib/version.rb
 - lib/writers/api_docs_writer.rb
@@ -85,8 +80,6 @@ files:
 - lib/writers/service_writer.rb
 - opt/config/schema.yml
 - opt/config/template.yml
-- opt/schema/controllers.yml
-- opt/schema/database.yml
 - opt/schema/routes.yml
 homepage: http://rubygems.org/gems/eworld
 licenses:

data/lib/rules/js/rule_js_parameters.rb

@@ -1,60 +0,0 @@
-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)
-        def self.run(js_data, errors)
-            raise RuntimeError, "Expected Array, instead got: #{errors.class}" unless errors.is_a?(Array)
-            @errors = errors
-            js_data.each { |data| handler(data[1][:file], data[1]) }
-            @errors
-        end
-
-        private
-
-        # @return void
-        def self.handler(file, data)
-
-            @file = file
-
-            data[:methods].each do |method_name, method_data|
-
-                begin
-
-                    @line        = method_data[:line]
-                    @line_number = method_data[:line_number]
-
-                    # Skip private methods.
-                    next if method_data[:private]
-
-                    expected = method_data[:params].keys
-                    actual   = method_data[:docs][:params].keys
-
-                    # Throw error if params don't match comments.
-                    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)
-                        missing_items = []
-                        missing_items << 'description' unless method_data[:docs].has_key?(:description)
-                        missing_items << 'return' unless method_data[:docs].has_key?(:return)
-                        if missing_items.any?
-                            @line        = "\xe2\x80\x94"
-                            @line_number = @line_number + 1
-                            raise RuntimeError, "Comment docs are missing \xe2\x86\x92 #{missing_items.join(', ')}"
-                        end
-                    end
-
-                rescue RuntimeError => e
-                    @errors << Blufin::ScannerError.new(@file, @line, @line_number, e.message)
-                end
-
-            end
-
-        end
-
-    end
-
-end

data/lib/scanners/controller_scanner.rb

@@ -1,137 +0,0 @@
-module EWorld
-
-    class ControllerScanner
-
-        SCHEMA_FILE = "#{App::Opt::get_base_path}#{App::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

@@ -1,15 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

data/opt/schema/controllers.yml

@@ -1,32 +0,0 @@
-type: map
-mapping:
-  EndPoints:
-    type: seq
-    sequence:
-      - type: map
-        mapping:
-          Path:
-            required: true
-            pattern: /^[a-z0-9\-\/]+$/
-          Method:
-            required: true
-            enum: [GET, POST, PUT, PATCH, DELETE]
-          RequestParams:
-            type: seq
-            sequence:
-              - type: map
-                mapping:
-                  Name:
-                    required: true
-                    pattern: /^[A-Za-z0-9]+$/
-                  Type:
-                    required: true
-                    enum: [String]
-                  Required:
-                    required: true
-                    type: bool
-          Permissions:
-            type: seq
-            sequence:
-              - type: str
-                pattern: /^[A-Z0-9_]+$/