Class: RokuBuilder::Analyzer

Inherits:
Util
  • Object
show all
Extended by:
Plugin
Defined in:
lib/roku_builder/plugins/analyzer.rb

Overview

Collects information on a package for submission

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Plugin

commands, dependencies, parse_options

Methods inherited from Util

#initialize

Constructor Details

This class inherits a constructor from RokuBuilder::Util

Class Method Details

.commands ⇒ Object 



9
10
11
12
13
 
# File 'lib/roku_builder/plugins/analyzer.rb', line 9

def self.commands
  {
    analyze: {source: true, stage: true},
  }
end

.dependencies ⇒ Object 



22
23
24
 
# File 'lib/roku_builder/plugins/analyzer.rb', line 22

def self.dependencies
  [Loader]
end

.parse_options(parser:, options:) ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/roku_builder/plugins/analyzer.rb', line 15

def self.parse_options(parser:, options:)
  parser.separator "Commands:"
  parser.on("--analyze", "Run a static analysis on a given stage") do
    options[:analyze] = true
  end
end

Instance Method Details

#analyze(options:, quiet: false) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/roku_builder/plugins/analyzer.rb', line 26

def analyze(options:, quiet: false)
  @options = options
  @warnings = []
  analyzer_config = get_analyzer_config
  @inspector_config = analyzer_config[:inspectors]
  loader = Loader.new(config: @config)
  Dir.mktmpdir do |dir|
    loader.copy(options: options, path: dir)
    raf_inspector = RafInspector.new(config: @config, dir: dir)
    manifest_inspector = ManifestInspector.new(config: @config, dir: dir, raf: raf_inspector)
    @warnings.concat(manifest_inspector.run(analyzer_config[:inspectors]))
    has_source_dir = false
    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)
      end
      has_source_dir  = true if file_path.end_with?("source")
    end
    unless has_source_dir
      add_warning(warning: :packageSourceDirectory, path: "source")
    end
    @warnings.concat(raf_inspector.run(analyzer_config[:inspectors]))
    print_warnings(dir) unless quiet
  end
  @warnings
end