nxgreport 0.8.0 → 0.11.2

data/lib/nxgcore.rb

@@ -1,420 +0,0 @@
-require 'fileutils'
-
-require 'nxgcss.rb'
-
-class NxgCore
-    class NxgReport
-
-        include NxgCss
-
-        def initialize(data_provider)
-          @data_provider = data_provider
-          @data_provider[:pass] = 0
-          @data_provider[:fail] = 0
-          @data_provider[:total] = 0
-        end
-
-        def setup(location: "./NxgReport.html", title: "Features Summary")
-            @data_provider[:report_path] = location.empty? ? "./NxgReport.html" : location
-            folder_check()
-            @data_provider[:title] = title
-            @data_provider[:title_color] = "background: linear-gradient(to bottom right, #ff644e, #cb3018);"
-            @data_provider[:open_on_completion] = false
-            @data_provider[:features] = Hash.new()
-            @start_time = Time.now.to_f
-        end
-
-        def set_title_color(hex_color: "")
-          if hex_color.strip().empty?() || hex_color.strip()[0] != "#"
-            log("set_title_color method is called with empty color. please check the code.")
-            return
-          end
-          @data_provider[:title_color] = "background-color: #{hex_color.strip().downcase()};"
-        end
-    
-        def open_upon_execution(value: true)
-          return if !value
-
-          @data_provider[:open_on_completion] = value
-        end
-    
-        def set_environment(name: "")
-          return if name.empty?() 
-          
-          @data_provider[:environment] = name
-        end
-    
-        def set_app_version(no: "")
-          return if no.empty?()
-            
-          version_no = no.downcase.gsub("app", "").gsub("version", "").strip
-          @data_provider[:app_version] = "App Version #{version_no}"
-        end
-    
-        def set_release(name: "")
-          return if name.empty?() 
-            
-          @data_provider[:release_name] = name
-        end
-    
-        def set_os(name: "")
-          return if name.empty?() 
-            
-          @data_provider[:os] = name
-        end
-    
-        def set_device(name: "")
-          return if name.empty?() 
-            
-          @data_provider[:device] = name
-        end
-    
-        def set_execution(date: "")
-          return if date.empty?() 
-            
-          @data_provider[:execution_date] = date
-        end
-    
-        def log_test(feature_name: "", test_status: "")
-          if feature_name.nil?() || feature_name.strip.empty?()
-            log("Feature name cannot be empty.")
-            return
-          end
-  
-          if test_status.nil?() || test_status.strip.empty?()
-            log("Test status cannot be empty.")
-            return
-          end
-          
-          test_pass = test_status.downcase.include?('pass')
-          name = feature_name.strip()
-  
-          if !@data_provider[:features].key?(name)
-            @data_provider[:features][name]=[0,0,0]
-          end
-
-          @data_provider[:features][name][0]+=1
-          @data_provider[:total]+=1
-          @data_provider[:features][name][(test_pass) ? 1 : 2]+=1
-          @data_provider[(test_pass) ? :pass : :fail]+=1
-        end
-    
-        def build(execution_time: 0)
-          set_execution_time(execution_time)
-          write()
-          if @data_provider[:open_on_completion]
-            system("open #{@data_provider[:report_path]}") if File.file?(@data_provider[:report_path])
-          end
-        end
-    
-        # Private methods
-        def log(message)
-          puts("🤖- #{message}")
-        end
-    
-        def folder_check()
-          folder = File.dirname(@data_provider[:report_path])
-          FileUtils.mkdir_p(folder) unless File.directory?(folder)
-        end
-    
-        def clean()
-            File.delete(@data_provider[:report_path]) if File.file?(@data_provider[:report_path])
-        end
-    
-        def write()
-          clean()
-          if @data_provider[:features].length == 0
-            log("No tests logged, cannot build empty report.")
-            return
-          end
-          template = File.new(@data_provider[:report_path], 'w')
-          template.puts("<html lang=\"en\">
-                          #{head()}
-                          #{body()}
-                          #{javascript()}
-                        </html>")
-          template.close()
-        end
-
-        def head()
-          "<head>
-            <meta charset=\"UTF-8\" />
-            <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />
-            <script src=\"https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js\"></script>
-            <title>Home | #{@data_provider[:title]}</title>
-            #{google_fonts_link()}
-            #{icons_link()}
-            #{css(@data_provider)}
-          </head>"
-        end
-
-        def google_fonts_link()
-          "<link
-            href=\"https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,300;0,400;0,600;0,700;0,800;1,300;1,400;1,600;1,700;1,800&display=swap\"
-            rel=\"stylesheet\"
-          />"
-        end
-
-        def icons_link()
-          "<link
-            href=\"https://fonts.googleapis.com/icon?family=Material+Icons\"
-            rel=\"stylesheet\"
-          />"
-        end
-
-        def body()
-          "<body class=\"dark\" id=\"app\" onload=\"onStart()\">
-            <div class=\"body-wrapper\">
-              #{header()}
-              #{config()}
-              #{features()}
-              #{footer()}
-            </div>
-          </body>"
-        end
-
-        def header()
-          "<div class=\"header\">
-            <h1>#{@data_provider[:title]}</h1>
-            <div class=\"button-wrapper\">
-              <button id=\"theme-switch\" onclick=\"handleThemeSwitch()\">
-                <i class=\"material-icons\" id=\"theme-switch-icon\">brightness_2</i>
-              </button>
-            </div>
-          </div>"
-        end
-
-        def features()
-          "<div class=\"mc\"></div>"
-      end
-
-      def features_js_array()
-        js_array = ''
-        @data_provider[:features].each do |name, metrics|
-          js_array += "{ name: \"#{name}\", total: #{metrics[0]}, pass: #{metrics[1]}, fail: #{metrics[2]} },"
-        end
-        return js_array
-      end
-
-        def footer()
-          "<div class=\"footer\">
-            <p>
-              Developed by
-              <span>
-                <a
-                  href=\"https://www.linkedin.com/in/balabharathijayaraman\"
-                  rel=\"nofollow\"
-                  target=\"_blank\"
-                  >Balabharathi Jayaraman</a
-                >
-              </span>
-            </p>
-          </div>"
-        end
-
-        def javascript()
-          "<script>
-            var theme = \"dark\";
-            var displayAllTests = true;
-            
-            var features = [
-                #{features_js_array()}
-            ]
-        
-            function onStart() {
-              displayAll();
-            }
-        
-            function handleThemeSwitch() {
-              if (theme === \"dark\") {
-                theme = \"light\";
-                document.getElementById(\"app\").classList.remove(\"dark\");
-                document.getElementById(\"theme-switch-icon\").innerHTML = \"wb_sunny\";
-                document.getElementById(\"theme-switch-icon\");
-                return;
-              }
-              if (theme === \"light\") {
-                theme = \"dark\";
-                document.getElementById(\"app\").classList.add(\"dark\");
-                document.getElementById(\"theme-switch-icon\").innerHTML = \"brightness_2\";
-              }
-            }
-        
-            function handleFilter() {
-              displayAllTests = !displayAllTests;
-              if (displayAllTests) {
-                displayAll();
-              } else {
-                displayFailuresOnly();
-              }
-            }
-        
-            function displayAll() {
-              $(\"#filter h5\").text(\"All\");
-              $(\".banner-in-the-middle\").removeClass(\"banner-in-the-middle\").addClass(\"mc\");
-              $(\".mc\").empty();
-              features.forEach((item) => {
-                $(\".mc\").append(
-                  `<div class=\"module dark ${
-                    item.fail > 0 ? \"danger\" : \"\"
-                  }\"><div class=\"funcname\"><h4>${
-                    item.name
-                  }</h4></div><div class=\"total\"><h6>Total</h6><h4>${
-                    item.total
-                  }</h4></div><div class=\"pass\"><h6>Passed</h6><h4>${
-                    item.pass
-                  }</h4></div><div class=\"fail\"><h6>Failed</h6><h4>${
-                    item.fail
-                  }</h4></div></div>`
-                );
-              });
-            }
-
-            function displayFailuresOnly() {
-              $(\"#filter h5\").text(\"Failures\");
-              $(\".banner-in-the-middle\").removeClass(\"banner-in-the-middle\").addClass(\"mc\");
-              $(\".mc\").empty();
-              failureCount = 0;
-              features.forEach((item) => {
-                if (item.fail > 0) {
-                  failureCount++;
-                  $(\".mc\").append(
-                    `<div class=\"module dark danger\"><div class=\"funcname\"><h4>${item.name}</h4></div><div class=\"total\"><h6>Total</h6><h4>${item.total}</h4></div><div class=\"pass\"><h6>Passed</h6><h4>${item.pass}</h4></div><div class=\"fail\"><h6>Failed</h6><h4>${item.fail}</h4></div></div>`
-                  );
-                }
-              });
-              if (failureCount === 0) {
-              $(\".mc\")
-                .removeClass(\"mc\")
-                .addClass(\"banner-in-the-middle\")
-                .append(
-                  `<i class=\"banner-text material-icons\">done_all</i><h1>No Failures</>`
-                );
-              }
-            }
-          </script>"
-        end
-    
-        def config()
-          return if @data_provider.length == 0
-
-          return "<div class=\"configuration-container\">
-                  #{release_name()}
-                  #{execution_date()}
-                  #{device()}
-                  #{os()}
-                  #{app_version()}
-                  #{environment()}
-                  #{passed_tests()}
-                  #{failed_tests()}
-                  #{percentage_pass()}
-                  #{execution_time()}
-                  #{filter()}
-                </div>"
-        end
-
-        def execution_time()
-          return if !@data_provider.key?(:environment)
-          
-          return config_item("Total execution time", @data_provider[:execution_time],'access_time')
-        end
-
-        def filter()
-          "<div class=\"configuration-wrapper\" onclick=\"handleFilter()\" id=\"filter\" title=\"Filter tests\">
-            <i class=\"configuration-icon material-icons\">filter_list</i>
-            <h5 id=\"configuration-text\">Failed</h5>
-          </div>"
-        end
-
-        def passed_tests()
-          "<div class=\"configuration-wrapper\" title=\"Passed tests\">
-            <i class=\"configuration-icon pass-total material-icons\">check_circle</i>
-            <h5 id=\"configuration-text\">#{@data_provider[:pass] == 0 ? "None" : @data_provider[:pass]}</h5>
-          </div>"
-        end
-
-        def failed_tests()
-          "<div class=\"configuration-wrapper\" title=\"Failed tests\">
-            <i class=\"configuration-icon fail-total material-icons\">cancel</i>
-            <h5 id=\"configuration-text\">#{@data_provider[:fail] == 0 ? "None" : @data_provider[:fail]}</h5>
-          </div>"
-        end
-
-        def percentage_pass()
-          pass_percentage = ((@data_provider[:pass]/@data_provider[:total].to_f) * 100).round(2)
-
-          return config_item("Pass percentage", pass_percentage,'equalizer')
-        end
-    
-        def environment()
-          return if !@data_provider.key?(:environment)
-
-          return config_item("Test environment", @data_provider[:environment], "layers")
-        end
-    
-        def app_version()
-          return if !@data_provider.key?(:app_version)
-
-          return config_item("App version tested", @data_provider[:app_version], "info")
-        end
-    
-        def release_name()
-          return if !@data_provider.key?(:release_name)
-
-          return config_item("Release", @data_provider[:release_name], "bookmark")
-        end
-    
-        def os()
-          return if !@data_provider.key?(:os)
-
-          return config_item("Os tested", @data_provider[:os], "settings")
-        end
-    
-        def device()
-          return if !@data_provider.key?(:device)
-            
-          return config_item("Device tested", @data_provider[:device], "devices")
-        end
-    
-        def execution_date()
-          @data_provider[:execution_date] = Time.now().strftime("%b %d, %Y") if !@data_provider.key?(:execution_date)
-            
-          return config_item("Execution date", @data_provider[:execution_date], "event")
-        end
-
-        def config_item(toot_tip, name, icon)
-          "<div class=\"configuration-wrapper\" title=\"#{toot_tip}\">
-            <i class=\"configuration-icon material-icons\">#{icon}</i>
-            <h5 id=\"configuration-text\">#{name}</h5>
-          </div>"
-        end
-
-        def set_execution_time(time)
-          time_diff_in_mins = 0
-          if time == 0
-            @end_time = Time.now.to_f
-            time_diff_in_mins = ((@end_time - @start_time)  / 60).to_i
-          else
-            time_diff_in_mins = (time / 60).to_i
-          end
-
-          if time_diff_in_mins >= 60
-            time_diff_in_hrs = (time_diff_in_mins / 60.to_f).round(2)
-            @data_provider[:execution_time] = "#{time_diff_in_hrs} #{time_diff_in_hrs == 1 ? "hour" : "hours"}"
-          else
-            @data_provider[:execution_time] = "#{time_diff_in_mins} mins"
-          end
-        end
-    
-        private :log, :clean, :write
-        private :execution_date, :device, :os, :release_name, :app_version, :environment
-        private :features, :config, :config_item, :features_js_array
-        private :head, :body, :header, :footer, :javascript
-    end
-
-    private_constant :NxgReport
-
-    def instance(data_provider: Hash.new())
-        NxgReport.new(data_provider)
-    end
-end

data/lib/nxgcss.rb

@@ -1,335 +0,0 @@
-
-module NxgCss
-
-    def has_environment_settings(data_provider)
-        data_provider.key?(:environment) || data_provider.key?(:app_version) || data_provider.key?(:release_name) || data_provider.key?(:os) || data_provider.key?(:device) || data_provider.key?(:execution_date)
-    end
-
-    def css(data_provider)
-        "<style>
-            :root {
-                --dark-bg: rgb(41, 40, 40);
-                --dark-primary: #050505;
-                --dark-secondary: #050505a9;
-                --dark-font: rgb(201, 201, 201);
-                --dark-blue: rgb(0, 225, 255);
-                --dark-green: rgba(115, 255, 0, 0.89);
-                --dark-red: rgb(255, 0, 0);
-                --dark-shadow: rgba(0, 0, 0, 0.5);
-        
-                --light-bg: rgb(226, 226, 226);
-                --light-primary: #fff;
-                --light-secondary: rgba(255, 255, 255, 0.445);
-                --light-font: rgb(44, 44, 44);
-                --light-blue: rgb(1, 67, 165);
-                --light-green: rgb(14, 138, 2);
-                --light-red: rgb(255, 0, 0);
-                --light-shadow: rgba(245, 245, 245, 0.5);
-        
-                --font: \"Open Sans\", sans-serif;
-                --danger-bg: rgba(255, 0, 0, 0.185);
-                --color-switch-animation: all 500ms ease;
-            }
-
-            body {
-                font-family: var(--font);
-                margin: auto;
-                transition: var(--color-switch-animation);
-            }
-
-            .body-wrapper {
-                display: grid;
-                grid-template-rows: auto auto 1fr;
-                height: 100vh;
-                width: 100vw;
-            }
-
-            .header {
-                display: grid;
-                grid-template-columns: 8fr 1fr;
-                text-align: center;
-                #{data_provider[:title_color]}
-            }
-
-            .configuration-container {
-                display: flex;
-                flex-wrap: wrap;
-                justify-content: space-between;
-                text-align: center;
-                padding: 1.5em 2em 1em 2em;
-            }
-
-            .configuration-wrapper {
-                display: flex;
-                place-items: center;
-            }
-
-            .configuration-icon {
-                font-size: 1.5em;
-                padding-right: 0.5em;
-            }
-
-            #configuration-text {
-                font-size: 0.85em;
-            }
-
-            #filter {
-                cursor: pointer;
-                border-radius: 1em;
-                width: 6em;
-                padding: 0.2em 0.8em;
-                background-color: var(--light-secondary);
-                -webkit-box-shadow: -1px 0px 5px 0px var(--light-shadow);
-                -moz-box-shadow: -1px 0px 5px 0px var(--light-shadow);
-                box-shadow: -1px 0px 5px 0px var(--light-shadow);
-            }
-
-            .mc {
-                display: grid;
-                grid-template-columns: 1fr 1fr 1fr;
-                grid-auto-rows: 70px;
-                grid-gap: 0.5em;
-                padding: 0.5em 2em;
-            }
-
-            .banner-in-the-middle {
-                text-align: center;
-                margin: auto;
-            }
-
-            .banner-text {
-                color: green;
-                font-size: 5em;
-            }
-
-            .banner-in-the-middle > h1 {
-                color: var(--light-font);
-            }
-
-            .footer {
-                margin-bottom: 0.5em;
-                padding: 3em 3em 1em 3em;
-                text-align: center;
-                font-size: 0.7rem;
-                font-weight: 600;
-            }
-
-            a {
-                cursor: pointer;
-                font-weight: 600;
-            }
-
-            .module {
-                display: grid;
-                place-items: center;
-                grid-template-columns: 3fr 1fr 1fr 1fr;
-                border-radius: 0.7rem;
-                padding: 10px 10px;
-                -webkit-box-shadow: -1px 0px 5px 0px var(--light-shadow);
-                -moz-box-shadow: -1px 0px 5px 0px var(--light-shadow);
-                box-shadow: -1px 0px 5px 0px var(--light-shadow);
-            }
-
-            .button-body-wrapper {
-                place-items: center;
-            }
-
-            #theme-switch {
-                width: 5em;
-                height: 5em;
-                background-color: Transparent;
-                background-repeat: no-repeat;
-                border: none;
-                cursor: pointer;
-                overflow: hidden;
-                outline: none;
-                margin: 0;
-                margin-right: 1em;
-                position: relative;
-                top: 50%;
-                -ms-transform: translateY(-50%);
-                transform: translateY(-50%);
-            }
-
-            h2,
-            h3,
-            h4,
-            h5,
-            h6 {
-                text-align: center;
-                margin: auto;
-            }
-
-            .total,
-            .pass,
-            .fail {
-                display: grid;
-                width: 100%;
-                height: 100%;
-                place-items: center;
-            }
-
-            body.dark {
-                background-color: var(--dark-bg);
-                color: var(--dark-font);
-            }
-
-            body.dark > .body-wrapper > .footer {
-                color: var(--dark-font);
-            }
-
-            body.dark > .body-wrapper > .mc > .module {
-                background-color: var(--dark-primary);
-                color: var(--dark-font);
-                -webkit-box-shadow: -1px 0px 5px 0px var(--dark-shadow);
-                -moz-box-shadow: -1px 0px 5px 0px var(--dark-shadow);
-                box-shadow: -1px 0px 5px 0px var(--dark-shadow);
-            }
-
-            body.dark > .body-wrapper > .mc > .module > .total {
-                color: var(--dark-blue);
-            }
-
-            body.dark > .body-wrapper > .mc > .module > .pass {
-                color: var(--dark-green);
-            }
-
-            body.dark > .body-wrapper > .mc > .module > .fail {
-                color: var(--dark-red);
-            }
-
-            body.dark > .body-wrapper > .configuration-container > .configuration-wrapper > .pass-total {
-                color: var(--dark-green);
-            }
-
-            body.dark > .body-wrapper > .configuration-container > .configuration-wrapper > .fail-total {
-                color: var(--dark-red);
-            }
-
-            body.dark > .body-wrapper > .mc > .module.danger {
-                background-color: rgba(255, 0, 0, 0.185);
-            }
-
-            body.dark > .body-wrapper > .banner-in-the-middle > h1 {
-                color: var(--dark-font);
-            }
-
-            body.dark > .body-wrapper > .header {
-                color: var(--dark-primary);
-            }
-
-            body.dark > .body-wrapper > .configuration-container > .configuration-wrapper {
-                color: var(--dark-font);
-            }
-
-            body.dark > .body-wrapper > .configuration-container > #filter {
-                background-color: var(--dark-secondary);
-                -webkit-box-shadow: -1px 0px 5px 0px var(--dark-shadow);
-                -moz-box-shadow: -1px 0px 5px 0px var(--dark-shadow);
-                box-shadow: -1px 0px 5px 0px var(--dark-shadow);
-            }
-
-            body.dark > .body-wrapper > .footer > p > span > a {
-                color: var(--dark-font);
-            }
-
-            body.dark > .body-wrapper > .header > div > button > #theme-switch-icon {
-                color: var(--dark-primary);
-            }
-
-            body {
-                background-color: var(--light-bg);
-                color: var(--dark-font);
-            }
-
-            body > .body-wrapper > .footer {
-                color: var(--light-font);
-            }
-
-            body > .body-wrapper > .mc > .module {
-                background-color: var(--light-primary);
-                color: var(--light-font);
-            }
-
-            body > .body-wrapper > .mc > .module > .total {
-                color: var(--light-blue);
-            }
-
-            body > .body-wrapper > .mc > .module > .pass {
-                color: var(--light-green);
-            }
-
-            body > .body-wrapper > .mc > .module > .fail {
-                color: var(--light-red);
-            }
-
-            body > .body-wrapper > .configuration-container > .configuration-wrapper > .pass-total {
-                color: var(--light-green);
-            }
-
-            body > .body-wrapper > .configuration-container > .configuration-wrapper > .fail-total {
-                color: var(--light-red);
-            }
-
-            body > .body-wrapper > .mc > .module.danger {
-                background-color: var(--danger-bg);
-            }
-
-            body > .body-wrapper > .header {
-                color: var(--light-primary);
-            }
-
-            body > .body-wrapper > .configuration-container > .configuration-wrapper {
-                color: var(--light-font);
-            }
-
-            body > .body-wrapper > .footer > p > span > a {
-                color: var(--light-font);
-            }
-
-            body > .body-wrapper > .header > div > button > #theme-switch-icon {
-                color: var(--light-primary);
-            }
-
-            @media only screen and (max-width: 600px) {
-                h1 {
-                    font-size: 24px;
-                }
-
-                .mc {
-                    grid-template-columns: 1fr;
-                    padding: 0.5em 0.5em;
-                    padding-top: 1em;
-                }
-
-                .configuration-container {
-                    padding: 0.5em 0em;
-                }
-
-                .configuration-wrapper {
-                    padding: 0.5em 1em;
-                }
-
-                .configuration-icon {
-                    font-size: 1em;
-                }
-
-                #configuration-text {
-                    font-size: 0.6em;
-                }
-
-                #filter {
-                    width: 4em;
-                    padding: 0.4em 0.4em;
-                    margin: 0.3em 0.7em 0.3em 0.7em;
-                }
-            }
-
-            @media (min-width: 600px) and (max-width: 992px) {
-                .mc {
-                    grid-template-columns: 1fr 1fr;
-                }
-            }
-        </style>"
-    end
-end