roku_builder 4.7.2 → 4.8.0

data/lib/roku_builder/plugins/manifest_attributes.json

@@ -0,0 +1,229 @@
+{
+  "title": {
+    "required": true
+  },
+  "major_version": {
+    "required": true,
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "minor_version": {
+    "required": true,
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "build_version": {
+    "required": true,
+    "validations": {
+      "integer": true,
+      "non_negative": true,
+      "not_equal": ["0"]
+    }
+  },
+  "mm_icon_focus_hd": {
+    "required": true,
+    "validations": {
+      "starts_with": "pkg:/"
+    },
+    "isResource": true,
+    "resolution": [336, 210]
+  },
+  "mm_icon_focus_sd": {
+    "required": true,
+    "validations": {
+      "starts_with": "pkg:/"
+    },
+    "isResource": true,
+    "resolution": [246, 140]
+  },
+  "splash_screen_fhd": {
+    "validations": {
+      "starts_with": "pkg:/"
+    },
+    "isResource": true,
+    "resolution": [1920, 1080]
+  },
+  "splash_screen_hd": {
+    "required": true,
+    "validations": {
+      "starts_with": "pkg:/"
+    },
+    "isResource": true,
+    "resolution": [1280, 720]
+  },
+  "splash_screen_sd": {
+    "required": true,
+    "validations": {
+      "starts_with": "pkg:/"
+    },
+    "isResource": true,
+    "resolution": [720, 480]
+  },
+  "splash_color": {
+    "validations": {
+      "hex": true
+    }
+  },
+  "splash_min_time": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "splash_rgs_optimization": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "ui_resolutions": {},
+  "uri_resolution_autosub": {},
+  "supports_input_launch": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "requires_audiometadata": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "requires_gaming_remote": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "requires_mkv": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "network_not_required": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "bs_libs_required": {},
+  "usb_media_handler": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "requires_aaxs_drm": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "requires_aaxs_drm": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "requires_aaxs_version": {
+    "validations": {
+      "float": true,
+      "non_negative": true
+    }
+  },
+  "requires_verimatrix_drm": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "requires_verimatrix_version": {
+    "validations": {
+      "float": true,
+      "non_negative": true
+    }
+  },
+  "hidden": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "playonly_aware": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "rsg_version": {
+    "validations": {
+      "float": true,
+      "non_negative": true
+    },
+    "notify": ["1.0"]
+  },
+  "automatic_audio_guide_disabled": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "bs_prof_enabled": {
+    "validations": {
+      "boolean": true
+    }
+  },
+  "bs_prof_sample_ratio": {
+    "validations": {
+      "float": true,
+      "non_negative": true
+    }
+  },
+  "confirm_partner_button": {
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  },
+  "suppress_unconnected_hud":{
+    "validations": {
+      "equals": ["0", "1"]
+    }
+  },
+  "screensaver_title": {},
+  "screensaver_private":{
+    "validations": {
+      "equals": ["0", "1"]
+    }
+  },
+  "subtitle": {
+    "deprecated": true
+  },
+  "mm_icon_side_hd": {
+    "deprecated": true,
+    "validations": {
+      "starts_with": "pkg:/"
+    },
+    "isResource": true
+  },
+  "mm_icon_side_sd": {
+    "deprecated": true,
+    "validations": {
+      "starts_with": "pkg:/"
+    },
+    "isResource": true
+  },
+  "requires_bluetooth": {
+    "deprecated": true,
+    "validations": {
+      "integer": true,
+      "non_negative": true
+    }
+  }
+}

data/lib/roku_builder/plugins/manifest_inspector.rb

@@ -0,0 +1,142 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+module RokuBuilder
+
+  class ManifestInspector
+    def initialize(config:, dir:, raf:)
+      @config = config
+      @dir = dir
+      @raf_inspector = raf
+    end
+
+    def run(inspector_config)
+      @warnings = []
+      @attributes = {}
+      @line_numbers = {}
+      @inspector_config = inspector_config
+      manifest = File.join(@config.root_dir, "manifest")
+      unless File.exist?(manifest)
+        add_warning(warning: :packageManifestFile)
+      else
+        File.open(manifest) do |file|
+          current_line = 0
+          file.readlines.each do |line|
+            current_line += 1
+            parts = line.split("=")
+            key = parts.shift.to_sym
+            if @attributes[key]
+              add_warning(warning: :manifestDuplicateAttribute, key: key, line: current_line)
+            else
+              value = parts.join("=").chomp
+              if !value or value == ""
+                add_warning(warning: :manifestEmptyValue, key: key, line: current_line)
+              else
+                @attributes[key] = value
+                @line_numbers[key] = current_line
+              end
+            end
+          end
+        end
+        manifest_attributes.each_pair do |key, attribute_config|
+          if @attributes[key]
+            if attribute_config[:deprecated]
+              add_warning(warning: :manifestDeprecatedAttribute, key: key)
+            end
+            if attribute_config[:validations]
+              attribute_config[:validations].each_pair do |type, value|
+                case type
+                when :integer
+                  unless @attributes[key].to_i.to_s == @attributes[key]
+                    add_warning(warning: :manifestInvalidValue, key: key)
+                  end
+                when :float
+                  unless @attributes[key].to_f.to_s == @attributes[key]
+                    add_warning(warning: :manifestInvalidValue, key: key)
+                  end
+                when :non_negative
+                  unless @attributes[key].to_f >= 0
+                    add_warning(warning: :manifestInvalidValue, key: key)
+                  end
+                when :not_equal
+                  if value.include? @attributes[key]
+                    add_warning(warning: :manifestInvalidValue, key: key)
+                  end
+                when :equals
+                  unless value.include? @attributes[key]
+                    add_warning(warning: :manifestInvalidValue, key: key)
+                  end
+                when :starts_with
+                  unless @attributes[key].start_with? value
+                    add_warning(warning: :manifestInvalidValue, key: key)
+                  end
+                else
+                  raise ImplementationError, "Unknown Validation"
+                end
+              end
+            end
+            if attribute_config[:notify]
+              attribute_config[:notify].each do |regexp|
+                if /#{regexp}/ =~ @attributes[key]
+                  add_warning(warning: :manifestHasValue, key: key)
+                  break
+                end
+              end
+            end
+            if attribute_config[:isResource]
+              path = File.join(@dir, @attributes[key].gsub("pkg:/", ""))
+              unless File.exist?(path)
+                mapping = {"{0}": @attributes[key], "{1}": key }
+                add_warning(warning: :manifestMissingFile, key: key, mapping: mapping)
+              else
+                if attribute_config[:resolution]
+                  size = ImageSize.path(path).size
+                  target = ImageSize::Size.new(attribute_config[:resolution])
+                  unless size == target
+                    mapping = {
+                      "{0}": @attributes[key],
+                      "{1}": key,
+                      "{2}": size,
+                      "{3}": target
+                    }
+                    add_warning(warning: :manifestIncorrectImageResolution, key: key, mapping: mapping)
+                  end
+                end
+              end
+            end
+          elsif attribute_config[:required]
+            add_warning(warning: :manifestMissingAttribute, key: key)
+          end
+          @raf_inspector.inspect_manifest(attributes: @attributes, line_numbers: @line_numbers)
+        end
+      end
+      @warnings
+    end
+
+    private
+
+    def manifest_attributes
+      file = File.join(File.dirname(__FILE__), "manifest_attributes.json")
+      JSON.parse(File.open(file).read, {symbolize_names: true})
+    end
+
+    def add_warning(warning:, key: nil, mapping: nil, line: nil)
+      @warnings.push(@inspector_config[warning].deep_dup)
+      @warnings.last[:path] = "manifest"
+      if line
+        @warnings.last[:line] = line
+      elsif @line_numbers[key]
+        @warnings.last[:line] = @line_numbers[key]
+      end
+      if mapping
+        mapping.each_pair do |map, value|
+          @warnings.last[:message].gsub!(map.to_s, value.to_s)
+        end
+      elsif key
+        @warnings.last[:message].gsub!("{0}", key.to_s)
+        if @attributes[key]
+          @warnings.last[:message].gsub!("{1}", @attributes[key])
+        end
+      end
+    end
+  end
+end

data/lib/roku_builder/plugins/raf_inspector.rb

@@ -0,0 +1,74 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+module RokuBuilder
+
+  class RafInspector
+    RAF_INTERFACE_INITIALIZATION_PATTERN = /roku_ads\(\)/i
+    LIBRARY_IMPORT_PATTERN = /\s*library\s*"roku_ads.brs"\s*/i
+
+    def initialize(config:, dir:)
+      @config = config
+      @dir = dir
+      @has_raf_interface_initialization = false
+      @interface_location = {}
+      @has_library_import = false
+      @import_location = {}
+      @has_manifest_entry = false
+      @manifest_location = {path: "manifest"}
+    end
+
+    def inspect_line(line:, file:, line_number:)
+      unless @has_raf_interface_initialization
+        @has_raf_interface_initialization = !!RAF_INTERFACE_INITIALIZATION_PATTERN.match(line)
+        if @has_raf_interface_initialization
+          @interface_location = {path: file, line: line_number}
+        end
+      end
+      unless @has_library_import
+        @has_library_import = !!LIBRARY_IMPORT_PATTERN.match(line)
+        if @has_library_import
+          @import_location = {path: file, line: line_number}
+        end
+      end
+    end
+
+    def inspect_manifest(attributes:, line_numbers:)
+      if attributes[:bs_libs_required] and attributes[:bs_libs_required].downcase == "roku_ads_lib"
+        @has_manifest_entry = true
+        @manifest_location[:line] = line_numbers[:bs_libs_required]
+      end
+    end
+
+    def run(inspector_config)
+      @warnings = []
+      @inspector_config = inspector_config
+      if @has_raf_interface_initialization and !@has_library_import
+        add_warning(warning: :rafConstructorPresentImportMissing, location: @interface_location)
+      end
+      if @has_raf_interface_initialization and !@has_manifest_entry
+        add_warning(warning: :rafConstructorPresentManifestMissing, location: @interface_location)
+      end
+      if !@has_raf_interface_initialization and @has_manifest_entry
+        add_warning(warning: :rafConstructorMissingManifestPresent, location: @manifest_location)
+      end
+      if @has_manifest_entry and !@has_library_import
+        add_warning(warning: :rafManifestPresentImportMissing, location: @manifest_location)
+      end
+      if !@has_raf_interface_initialization and @has_library_import
+        add_warning(warning: :rafConstructorMissingImportPresent, location: @import_location)
+      end
+      if @has_raf_interface_initialization and @has_library_import and @has_manifest_entry
+        add_warning(warning: :rafProperIntegration, location: @import_location)
+      end
+      @warnings
+    end
+
+    private
+
+    def add_warning(warning:, location:)
+      @warnings.push(@inspector_config[warning].deep_dup)
+      @warnings.last[:path] = location[:path]
+      @warnings.last[:line] = location[:line]
+    end
+  end
+end

data/lib/roku_builder/version.rb

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

data/lib/roku_builder.rb

@@ -25,6 +25,8 @@ require "fileutils"
 require "tempfile"
 require "tmpdir"
 require "zip"
+#analyzer
+require "image_size"
 
 
 Dir.glob(File.join(File.dirname(__FILE__), "roku_builder", "*.rb")).each do |path|

data/roku_builder.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "net-telnet",          "~> 0.1"
   spec.add_dependency "oga",                 "~> 2.11"
   spec.add_dependency "win32-security",      "~> 0.5" # For windows compatibility
+  spec.add_dependency "image_size",          "~> 2.0"
 
   spec.add_development_dependency "bundler",           "~> 1.7"
   spec.add_development_dependency "rake",              "~> 12.0"