roku_builder 4.14.1 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28e303ec07cdadeab357258626a2dc7ac99022d9
-  data.tar.gz: fd728532cabed6972d049228335d8d81d805a022
+  metadata.gz: 62fc3eeb8342b7b051b3fb0c96ca465328da1132
+  data.tar.gz: '0739f417d2fdd6cfc2d3ab4755e6cef51bfd70a1'
 SHA512:
-  metadata.gz: 556c367b93d5d1d5ad51b50597eabee9529923f7c168614a0be6e61010a28f8b50d150dd02d79120cb64d27dcabe2aa8d7135fa093baa3a107786d7e86acbc84
-  data.tar.gz: 102ce72c84846d63b8971817a326e5393b4f3a746012a3df701d229855f51d74b2022200dd09ff5dfecf8424c8566b92faabaddc924fcc3241ffa563aa25d1d4
+  metadata.gz: 2a8822179c1be73aa66fa86a16006e9b9085e311834c721aabe454552e7e8e610439c89566f626d6ec54f678198769d48f3d6422c8a1e88a2f2864fe062685f8
+  data.tar.gz: 74bcb13af4721aa3bb22312b37c6820249a79f03fdbb5445a25d78630766516c19e4e69e7eaeff976506191c8c13ead65d5637ecac6e89813b2fa9f1de8c09f6

data/CHANGELOG

@@ -1,3 +1,7 @@
+ = 4.15.0 =
+
+ - Add indentation checking to analyze command
+
  = 4.14.1 =
 
  - Rebuild of gem

data/lib/roku_builder/plugins/analyzer.rb

@@ -33,6 +33,7 @@ module RokuBuilder
       analyzer_config = get_config("inspector_config.json")
       performance_config = get_config("performance_config.json")
       linter_config = get_config(".roku_builder_linter.json", true)
+      linter_config ||= {}
       @inspector_config = analyzer_config[:inspectors]
       loader = Loader.new(config: @config)
       Dir.mktmpdir do |dir|
@@ -49,8 +50,8 @@ module RokuBuilder
             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_config += linter_config if linter_config
-              line_inspector = LineInspector.new(config: @config, raf: raf_inspector, inspector_config: line_inspector_config)
+              line_inspector_config += linter_config[:rules] if linter_config[:rules]
+              line_inspector = LineInspector.new(config: @config, raf: raf_inspector, inspector_config: line_inspector_config, indent_config: linter_config[:indentation])
               @warnings.concat(line_inspector.run(file_path))
             end
             if file_path.end_with?("__MACOSX")

data/lib/roku_builder/plugins/indentation_inspector.rb

@@ -0,0 +1,83 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+module RokuBuilder
+  class IndentationInspector
+    attr_reader :warnings
+    def initialize(rules:, path:)
+      @character = get_character(rules[:character])
+      @count = rules[:count].to_i
+      @path = path
+      @type = File.extname(path)[1..-1].to_sym
+      @warnings = []
+      @prev_line = nil
+      @ind = 0
+    end
+
+    def check_line(line:, number:)
+      #byebug if number == 191 and @path.ends_with?("EpisodeGuide.animation.brs")
+      set_indentation(line: line)
+      regexp = /^#{@character}{#{@ind}}[^#{@character}]/
+      unless line =~ regexp or line == "\n"
+        add_warning(line: number)
+      end
+      @prev_line = line
+    end
+
+    def set_indentation(line:)
+      case @type
+      when :xml
+        if @prev_line and @prev_line =~ /<[^?!\/][^>]*[^\/]>/
+          unless @prev_line =~ /<([^>\/]*)>.*<\/\1*>/
+            @ind += @count
+          end
+        end
+        if line =~ /<\/[^>]*>/
+          unless line =~ /<([^>\/]*)>.*<\/\1*>/
+            @ind -= @count
+          end
+        end
+      when :brs
+        if @prev_line
+          if @prev_line =~ /[\{\[\(:]$/
+            @ind += @count
+          elsif @prev_line =~ /^\s*\bfunction\b|^\s*\bsub\b/i
+            @ind += @count
+          elsif @prev_line =~ /^\s*#?if\b|^\s*#?else\b/i
+            unless @prev_line =~ /\bthen\b[ \t ]*[^' \r\n']+.*$/i or @prev_line =~ /\breturn\b/i
+              @ind += @count
+            end
+          elsif @prev_line =~ /^\s*\bfor\b|^\s*\bwhile\b/i
+            @ind += @count
+          end
+        end
+        if line =~ /^\s*[\}\]\)]/
+          @ind -= @count
+        elsif line =~ /^\s*\bfunction\b|^\s*\bsub\b/i
+          @ind -= 0
+        elsif line =~ /^\s*#?end\b|^\s*#?endif\b|^\s*endfor\b|^\s*\bnext\b/i
+          @ind -= @count
+        elsif line =~ /^\s*#?else\b|^\s*elseif\b/i
+          @ind -= @count
+        end
+      end
+    end
+
+    private
+
+    def get_character(character)
+      case character
+      when "tab"
+        "\t"
+      when "space"
+        " "
+      end
+    end
+
+    def add_warning(line:)
+      @warnings.push({severity: "warning", message: 'Incorrect indentation'})
+      @warnings.last[:path] = @path
+      @warnings.last[:line] = line
+    end
+  end
+end
+

data/lib/roku_builder/plugins/line_inspector.rb

@@ -3,18 +3,20 @@
 module RokuBuilder
 
   class LineInspector
-    def initialize(config:, raf:, inspector_config:)
+    def initialize(config:, raf:, inspector_config:, indent_config:)
       @config = config
       @raf_inspector = raf
       @inspector_config = inspector_config
+      @indent_config = indent_config
     end
 
     def run(file_path)
       @warnings = []
       File.open(file_path) do |file|
-        line_number = 0
         in_xml_comment = false
-        file.readlines.each do |line|
+        indent_inspector = IndentationInspector.new(rules: @indent_config, path: file_path) if @indent_config
+        file.readlines.each_with_index do |line, line_number|
+          indent_inspector.check_line(line: line, number: line_number) if indent_inspector
           full_line = line.dup
           line = line.partition("'").first if file_path.end_with?(".brs")
           if file_path.end_with?(".xml")
@@ -42,8 +44,8 @@ module RokuBuilder
             end
           end
           @raf_inspector.inspect_line(line: line, file: file_path, line_number: line_number)
-          line_number += 1
         end
+        @warnings += indent_inspector.warnings if indent_inspector
       end
       @warnings
     end

data/lib/roku_builder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder
 version: !ruby/object:Gem::Version
-  version: 4.14.1
+  version: 4.15.0
 platform: ruby
 authors:
 - greeneca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -486,6 +486,7 @@ files:
 - lib/roku_builder/plugin.rb
 - lib/roku_builder/plugins/analyzer.rb
 - lib/roku_builder/plugins/core.rb
+- lib/roku_builder/plugins/indentation_inspector.rb
 - lib/roku_builder/plugins/inspector.rb
 - lib/roku_builder/plugins/inspector_config.json
 - lib/roku_builder/plugins/line_inspector.rb