eworld 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e5552cd65eb30561e3a62e5d6aa469f546c7cf6
-  data.tar.gz: b7b1bc3674c029e29bf7559c08ee8e56908782c0
+  metadata.gz: 75950a16fbe8126fcd439351997bf68c4d912f67
+  data.tar.gz: fe5d72a612293037e4667379eea1a4be21f750ef
 SHA512:
-  metadata.gz: '08fbdf3ce162d5d94631c8511f73123728a4c2689ee11434ce56448415fcb35b8cb2e72e3ca87f165a3dde577b0235ea0e539b80f7cacd9c4b08cbcf315d9ff1'
-  data.tar.gz: e70e8bad0a5cbc09490c78ebd0b7a44ba34fc0c04601816022ee438c398f12815ec45f5a0d527b054aea8ba34f5c16ddf9ed733530c5c187027c3960bd43a04d
+  metadata.gz: 5176d9ea6e1f28b299b26f380f00d412282eb617e6e9ca998b0c8d1a8f7eccd09bb482aad5e4d4725ecb7dbb50adcfbb92127c25ce8e8e35b29f46c77a9011fa
+  data.tar.gz: 4fd6382b37596917e580333ceaec8f52d45a8733d70df92b44b87de6545bff708a7a92b03328009fa999d9cb2bf4c6a65d3f130bf2e487442028046683c68bad

data/lib/core/opt.rb

@@ -1,4 +1,4 @@
-module App
+module EWorld
 
     class Opt
 

data/lib/eworld.rb

@@ -6,12 +6,13 @@ require_relative 'version'
 
 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) }
 
 module App
 
     GEM_NAME      = 'eworld'
-    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"
+    SCHEMA_FILE   = "#{EWorld::Opt::get_base_path}#{EWorld::Opt::OPT_PATH}/config/schema.yml"
+    TEMPLATE_FILE = "#{EWorld::Opt::get_base_path}#{EWorld::Opt::OPT_PATH}/config/template.yml"
     CONFIG_FILE   = '~/.eworld.yml'
     SECRET        = 'dLZDk82LU8kEZ6pbcuyJHmbrWs3ujzvM2cHNtD6BgKyvDZAcJRjU7yHde7nWejnR'
 
@@ -39,48 +40,53 @@ TEMPLATE
                 app.description "\x1B[38;5;240mAn internal tool intended for improving/automating development tasks.\x1B[0m"
 
                 # g - GENERATE
-                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
+                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 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
+                        # 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
                         end
-                        # GENERATE UI (Default)
-                        generate_ui.action do
-                            system("#{App::GEM_NAME} g u -h")
+                        # GENERATE (Default)
+                        generate.action do
+                            system("#{App::GEM_NAME} g -h")
                         end
                     end
-                    # GENERATE (Default)
-                    generate.action do
-                        system("#{App::GEM_NAME} g -h")
-                    end
                 end
 
                 # s - SCAN
                 if is_albert_mac
                     app.command :scan, :aliases => [:s] do |scan|
-                        scan.summary 'Scan the codebase for inconsistencies'
+                        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

data/lib/routes/scan.rb

@@ -26,13 +26,26 @@ module AppCommand
 
         def opts_routing
 
-            projects = Blufin::Projects.get_projects_as_array(types: [Blufin::Projects::TYPE_QUASAR, Blufin::Projects::TYPE_API_SIMPLE])
-            project  = Blufin::Projects.show_project_prompt(projects)
+            # TODO - This cannot be hard-coded forever!
+            project = 'fmm'
 
-            # TODO - REMOVE
-            raise RuntimeError, 'Not yet implemented!'
+            @results = Blufin::Scanner::scan(project)
+            @errors  = @results[:errors]
 
-            @scanner = Blufin::Scanner::new
+            run_js_rules(@results[:js_data]) unless @results[:js_data].nil?
+
+            # Output Errors (if any).
+            Blufin::ScannerError::output_cli(@errors) if @errors.any?
+
+        end
+
+        private
+
+        # Runs all the rules for the JS files.
+        # @return void
+        def run_js_rules(data)
+
+            @errors = EWorld::RuleJsParameters::run(data, @errors)
 
         end
 

data/lib/rules/js/rule_js_parameters.rb

@@ -0,0 +1,61 @@
+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 { |file, data| handler(file, data) }
+            @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, "Params docs (for #{method_name}) are missing or don't match." 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/version.rb

@@ -1 +1 @@
-EWORLD_VERSION = '1.2.1'
+EWORLD_VERSION = '1.2.2'

data/opt/config/schema.yml

@@ -7,7 +7,6 @@ mapping:
         required: true
   Databases:
     type: seq
-    required: yes
     sequence:
       - type: map
         mapping:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eworld
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Albert Rannetsperger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blufin-lib
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: columnist
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +67,7 @@ files:
 - lib/routes/generate_api_entities.rb
 - lib/routes/generate_ui_routes.rb
 - lib/routes/scan.rb
+- lib/rules/js/rule_js_parameters.rb
 - lib/version.rb
 - opt/config/schema.yml
 - opt/config/template.yml
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: eWorld-CLI.