roku_builder 4.8.2 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7406e49f56028e7b453dced404c279af36f4619e
-  data.tar.gz: 67cffee550e2059add97755ae247e29966a6f6ef
+  metadata.gz: 826bb48694fa32bff380d9ea9143772b019d3845
+  data.tar.gz: ab2c380e350b704fe788f04fcdab7c30655f176c
 SHA512:
-  metadata.gz: 953875238157d4dfda237ca8c860af59ab85c205d4d6b8dbe6d79e837492daa399464e8b99778456bb52b3884f601e4c9d70b8958cd589518d89de16a5990d0e
-  data.tar.gz: 31b36d4a0720ce67ce20c1e5e5c6d3c505ab1a1dbf2213b549e8db6383dd110da71679574d9ccd7881ce9c37a4cef177fad55c6670e75462bd3b0b9f8b635a69
+  metadata.gz: 24f1e3f0f88aa3bd262e48a3f83b1a38962e0c050432da73c6d230447dbc807179577ba7ceddecb1cf1aa20b05a2c13d11e0bfea85b6e8311ae506bc0527b209
+  data.tar.gz: 2cb77fd249b35bfa5e4b0c819f317911642944e6ee1c47120a8773617224a1c9b7bf8c63e244fd1157eb8f5f047d029f8657e106c5a184ff50d26897751fe654

data/CHANGELOG

@@ -1,3 +1,7 @@
+ = 4.9.0 =
+
+ - Add performance checks to --analyze command
+
  = 4.8.2 =
 
  - Sort --profile textures command

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roku_builder (4.8.2)
+    roku_builder (4.9.0)
       faraday (~> 0.13)
       faraday-digestauth (~> 0.2)
       git (~> 1.3)

data/lib/roku_builder/array.rb

@@ -0,0 +1,12 @@
+# ********** Copyright 2016 Viacom, Inc. Apache 2.0 **********
+
+class ::Array
+  def any_is_start?(full_string)
+    each do |item|
+      if full_string.start_with?(item)
+        return true
+      end
+    end
+    return false
+  end
+end

data/lib/roku_builder/plugins/analyzer.rb

@@ -17,6 +17,10 @@ module RokuBuilder
       parser.on("--analyze", "Run a static analysis on a given stage") do
         options[:analyze] = true
       end
+      parser.separator "Options:"
+      parser.on("--inclide-libraries", "Include libraries in analyze") do
+        options[:include_libraries] = true
+      end
     end
 
     def self.dependencies
@@ -26,7 +30,9 @@ module RokuBuilder
     def analyze(options:, quiet: false)
       @options = options
       @warnings = []
-      analyzer_config = get_analyzer_config
+      plugin_config = get_config(".roku_builder_analyze.json", true) || {}
+      analyzer_config = get_config("inspector_config.json")
+      performance_config = get_config("performance_config.json")
       @inspector_config = analyzer_config[:inspectors]
       loader = Loader.new(config: @config)
       Dir.mktmpdir do |dir|
@@ -35,16 +41,23 @@ module RokuBuilder
         manifest_inspector = ManifestInspector.new(config: @config, dir: dir, raf: raf_inspector)
         @warnings.concat(manifest_inspector.run(analyzer_config[:inspectors]))
         has_source_dir = false
+        libraries = plugin_config[:libraries]
+        libraries ||= []
         Dir.glob(File.join(dir, "**", "*")).each do |file_path|
-          if File.file?(file_path) and file_path.end_with?(".brs", ".xml")
-            line_inspector = LineInspector.new(config: @config, raf: raf_inspector, inspector_config: analyzer_config[:lineInspectors])
-            @warnings.concat(line_inspector.run(file_path))
-          end
-          if file_path.end_with?("__MACOSX")
-            add_warning(warning: :packageMacosxDirectory, path: file_path)
-          end
-          if file_path.end_with?(".zip", ".md", ".pkg")
-            add_warning(warning: :packageExtraneousFiles, path: file_path)
+          file = file_path.dup; file.slice!(dir)
+          unless libraries.any_is_start?(file) and not @options[:include_libraries]
+            if File.file?(file_path) and file_path.end_with?(".brs", ".xml")
+              line_inspector_config = analyzer_config[:lineInspectors]
+              line_inspector_config += performance_config
+              line_inspector = LineInspector.new(config: @config, raf: raf_inspector, inspector_config: line_inspector_config)
+              @warnings.concat(line_inspector.run(file_path))
+            end
+            if file_path.end_with?("__MACOSX")
+              add_warning(warning: :packageMacosxDirectory, path: file_path)
+            end
+            if file_path.end_with?(".zip", ".md", ".pkg")
+              add_warning(warning: :packageExtraneousFiles, path: file_path)
+            end
           end
           has_source_dir  = true if file_path.end_with?("source")
         end
@@ -59,12 +72,13 @@ module RokuBuilder
 
     private
 
-    def get_analyzer_config
-      #url = "http://devtools.web.roku.com/static-code-analyzer/config.json"
-      #url = @options[:analyze_config] if @options[:analyze_config]
-      #JSON.parse(Faraday.get(url).body, {symbolize_names: true})
-      file = File.join(File.dirname(__FILE__), "inspector_config.json")
-      JSON.parse(File.open(file).read, {symbolize_names: true})
+    def get_config(file, project_root=false)
+      if project_root
+        file = File.join(@config.root_dir, file)
+      else
+        file = File.join(File.dirname(__FILE__), file)
+      end
+      JSON.parse(File.open(file).read, {symbolize_names: true}) if File.exist? file
     end
 
     def add_warning(warning:, path:)

data/lib/roku_builder/plugins/line_inspector.rb

@@ -15,6 +15,7 @@ module RokuBuilder
         line_number = 0
         in_xml_comment = false
         file.readlines.each do |line|
+          full_line = line.dup
           line = line.partition("'").first if file_path.end_with?(".brs")
           if file_path.end_with?(".xml")
             if in_xml_comment
@@ -28,8 +29,10 @@ module RokuBuilder
             in_xml_comment = true if line.gsub!(/<!--.*/, "")
           end
           @inspector_config.each do |line_inspector|
-            if /#{line_inspector[:regex]}/.match(line)
-              add_warning(inspector: line_inspector, file: file_path, line: line_number)
+            if /#{line_inspector[:regex]}/i.match(line)
+              unless /'.*ignore-warning/i.match(full_line)
+                add_warning(inspector: line_inspector, file: file_path, line: line_number)
+              end
             end
           end
           @raf_inspector.inspect_line(line: line, file: file_path, line_number: line_number)

data/lib/roku_builder/plugins/performance_config.json

@@ -0,0 +1,27 @@
+[
+  {
+    "regex": "\\sas\\s(Object|Boolean|String|Integer|LongInteger|Double|Float|Function|Dynamic)",
+    "severity": "warning",
+    "message": "Found function return type. Consider removing"
+  } ,
+  {
+    "regex": "DoesExist",
+    "severity": "warning",
+    "message": "Found DoesExist check. Try using invalid check on dot referance"
+  },
+  {
+    "regex": "\\[\"[^\"]+\"\\]",
+    "severity": "warning",
+    "message": "Found AA String referance. Try switching to dot referance"
+  },
+  {
+    "regex": "FOR.*TO",
+    "severity": "warning",
+    "message": "For loop found. Try switching to a For Each loop"
+  },
+  {
+    "regex": "\"roRegex\"",
+    "severity": "warning",
+    "message": "Regexp found. Avoid if possible"
+  }
+]

data/lib/roku_builder/version.rb

@@ -2,5 +2,5 @@
 
 module RokuBuilder
   # Version of the RokuBuilder Gem
-  VERSION = "4.8.2"
+  VERSION = "4.9.0"
 end

data/test/roku_builder/plugins/test_analyzer.rb

@@ -9,7 +9,7 @@ module RokuBuilder
       RokuBuilder.class_variable_set(:@@dev, false)
       RokuBuilder.setup_plugins
       register_plugins(Analyzer)
-      @config, @options = build_config_options_objects(AnalyzerTest, {analyze: true, working: true, quiet_analyze: true}, false)
+      @config, @options = build_config_options_objects(AnalyzerTest, {analyze: true, working: true}, false)
       @root_dir = @config.root_dir
       @device_config = @config.device_config
       FileUtils.cp(File.join(@root_dir, "manifest_template"), File.join(@root_dir, "manifest"))
@@ -26,6 +26,7 @@ module RokuBuilder
     def teardown
       manifest = File.join(@root_dir, "manifest")
       FileUtils.rm(manifest) if File.exist?(manifest)
+      remove_config
       @request_stubs.each {|req| remove_request_stub(req)}
     end
     def test_analyzer_parse_commands
@@ -252,7 +253,7 @@ module RokuBuilder
     def test_macosx_directory
       config = good_config(AnalyzerTest)
       config[:projects][:project1][:folders].push("Test__MACOSX")
-      @config, @options = build_config_options_objects(AnalyzerTest, {analyze: true, working: true, quiet_analyze: true}, false, config)
+      @config, @options = build_config_options_objects(AnalyzerTest, {analyze: true, working: true}, false, config)
       folder = File.join(@root_dir, "Test__MACOSX")
       Dir.mkdir(folder) unless File.exist?(folder)
       warnings = test
@@ -297,6 +298,70 @@ module RokuBuilder
     def test_logging_info
       test_logger_with_file_content(text: "\"roSGScreen\"", severity: :info)
     end
+    def test_performance_function_return_types
+      warnings = test_file(text: "function test() as String\n? \"test\"\nend function")
+      assert_equal 1, warnings.count
+      assert_match(/function return/, warnings[0][:message])
+    end
+    def test_performance_function_return_types_lowercase
+      warnings = test_file(text: "function test() as string\n? \"test\"\nend function")
+      assert_equal 1, warnings.count
+      assert_match(/function return/, warnings[0][:message])
+    end
+    def test_performance_aa_does_exist
+      warnings = test_file(text: "exists = aa.doesExist(\"test\")")
+      assert_equal 1, warnings.count
+      assert_match(/DoesExist check/, warnings[0][:message])
+    end
+    def test_performance_aa_string_ref
+      warnings = test_file(text: "aa[\"test\"] = \"test\"")
+      assert_equal 1, warnings.count
+      assert_match(/String referance/, warnings[0][:message])
+    end
+    def test_performance_for_loop
+      warnings = test_file(text: "FOR i=0 TO 10\n ? i\nEND FOR")
+      assert_equal 1, warnings.count
+      assert_match(/For loop found/, warnings[0][:message])
+    end
+    def test_performance_for_loop_lower_case
+      warnings = test_file(text: "for i=0 to 10\n ? i\nEND FOR")
+      assert_equal 1, warnings.count
+      assert_match(/For loop found/, warnings[0][:message])
+    end
+    def test_performance_for_loop_title_case
+      warnings = test_file(text: "For i=0 To 10\n ? i\nEND FOR")
+      assert_equal 1, warnings.count
+      assert_match(/For loop found/, warnings[0][:message])
+    end
+    def test_performance_regex
+      warnings = test_file(text: "\"roRegex\"")
+      assert_equal 1, warnings.count
+      assert_match(/Regexp found/, warnings[0][:message])
+    end
+    def test_library_skip
+      set_config({libraries: ["/source/test.brs"]})
+      warnings = test_file(text: "\"roRegex\"")
+      assert_equal 0, warnings.count
+    end
+    def test_library_skip_folder
+      set_config({libraries: ["/source"]})
+      warnings = test_file(text: "\"roRegex\"")
+      assert_equal 0, warnings.count
+    end
+    def test_library_include
+      @config, @options = build_config_options_objects(AnalyzerTest, {analyze: true, working: true, include_libraries: true}, false)
+      set_config({libraries: ["/source/test.brs"]})
+      warnings = test_file(text: "\"roRegex\"")
+      assert_equal 1, warnings.count
+    end
+    def test_performance_skip_warning_comment
+      warnings = test_file(text: "function test() as String 'ignore-warning\n? \"test\"\nend function")
+      assert_equal 0, warnings.count
+    end
+    def test_performance_skip_warning_comment_upper_case
+      warnings = test_file(text: "function test() as String 'IGNORE-WARNING\n? \"test\"\nend function")
+      assert_equal 0, warnings.count
+    end
 
 
     private
@@ -342,6 +407,19 @@ module RokuBuilder
       analyzer.analyze(options: @options, quiet: quiet)
     end
 
+    def set_config(config_content)
+      config = File.join(@root_dir, ".roku_builder_analyze.json")
+      File.open(config, "w") do |file|
+        file.write(config_content.to_json)
+      end
+    end
+
+    def remove_config
+      config = File.join(@root_dir, ".roku_builder_analyze.json")
+      FileUtils.rm(config) if File.exist? config
+    end
+
+
     def print_all(warnings)
       warnings.each do |warning|
         puts warning[:message]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder
 version: !ruby/object:Gem::Version
-  version: 4.8.2
+  version: 4.9.0
 platform: ruby
 authors:
 - greeneca
@@ -474,6 +474,7 @@ files:
 - intergration/roku_builder/test_scripter.rb
 - intergration/roku_builder/test_tester.rb
 - lib/roku_builder.rb
+- lib/roku_builder/array.rb
 - lib/roku_builder/config.rb
 - lib/roku_builder/config_parser.rb
 - lib/roku_builder/config_validator.rb
@@ -496,6 +497,7 @@ files:
 - lib/roku_builder/plugins/monitor.rb
 - lib/roku_builder/plugins/navigator.rb
 - lib/roku_builder/plugins/packager.rb
+- lib/roku_builder/plugins/performance_config.json
 - lib/roku_builder/plugins/profiler.rb
 - lib/roku_builder/plugins/raf_inspector.rb
 - lib/roku_builder/plugins/scripter.rb