roku_builder_generator 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1689feb43f47e343530956db694328c6777d0949df073ee9187b274d53a4658c
-  data.tar.gz: 498b94cd2b6e266d3ef1dcd8bf145fa19e177de83e531fe04716e212e73e6202
+  metadata.gz: 1853683defadf4bb9cf28a4b5aea7cc60fc7726bbcdaefece8956c5bc9b9436d
+  data.tar.gz: 8e46fd60a6bee8db1f4dc5f5e747084377b3a4cb8f80b883f959bbab19c1c126
 SHA512:
-  metadata.gz: 9937fb52d8f1701a4c40a85db4d793ae16b840c00ddb21b05b8070713d156f4a52951cf7a1de0dc7bfade4ce23ba0cec772695b889928c6c3fab4e22dc88b286
-  data.tar.gz: 5afc1b7ee76064e0ed340c15959bbbfb8e9755df8e917f5d3289e86b5556245401ab1a6ffe74423003265ead8327ecd03245fd78b08472982944bc76e945d683
+  metadata.gz: 9cab4f02389e86b1fe1a3ec96868a8919dbbfdee1ff956d6ee953c651eaa22e9f739e80b11b201504272dde389b9e2afba07d9be12ffc300d3032b998673e0b6
+  data.tar.gz: 7d314841d2473bfd2ff4f1fcc881a0eb5a3643e8c35ec111f69f29bf89cf7c28d8938a669864902b0f007f7b817415e051136c1bc76d17e4e19148b3e6e26b6d

data/README.md

@@ -31,6 +31,10 @@ Options:
         --base-dir                   Base directory for generated brs/xml code (eg.: 'brands/core/components/<type>s')
         --with-config                Add empty config JSON
         --config-dir                 Use custom directory for config json (eg.: 'brands/core/region/US/configs/<type>s')
+        --with-tests                 Add unit tests
+        --only-tests                 Only unit tests
+        --tests-dir                  Use custom directory for unit tests
+
 ```
 
 ### Examples
@@ -43,6 +47,10 @@ Generate a task ("Bar"), but just display the output on screen:
 
 `roku --generate task --name bar --dry-run -V`
 
+Generate a module ("Buz"), and also generate config and unit tests
+
+`roku --generate module --name buz --with-config --with-tests`
+
 ### Config
 
 You can supplement the default configuration using a local file `.roku_builder_generator.json`

data/lib/roku_builder/plugins/generator.rb

@@ -7,6 +7,7 @@ def default_config()
   return {
     :component_dir => "brands/%brand%/components",
     :config_dir => "brands/%brand%/region/US/configs",
+    :unitTests_dir => "brands/unit-tests/components/tests",
     :template_dir => "roku_builder_generator"
   }
 end
@@ -23,6 +24,11 @@ def default_config_dir(component_type, brand = 'core', base_dir = nil)
   return "#{base_dir}/#{component_type.capitalize()}s"
 end
 
+def default_unitTests_dir(component_type, base_dir = nil)
+  base_dir = base_dir || default_config[:unitTests_dir]
+  return "#{base_dir}/#{component_type.capitalize()}s"
+end
+
 
 def replace_brand(directory, newBrand = 'core')
   directory["%brand%"]=newBrand
@@ -65,6 +71,12 @@ module RokuBuilder
       return "./#{base_dir}"
     end
 
+    def get_unitTests_output_dir(component_type, component_name, custom_dir = nil )
+      output_dir = get_directory_name(component_type, component_name)
+      base_dir = !custom_dir.nil? ? custom_dir : default_unitTests_dir(component_type)
+      return "./#{base_dir}/#{output_dir}"
+    end
+
     # Hook to add options to the parser
     # The keys set in options for commands must match the keys in the commands
     #   hash
@@ -93,6 +105,16 @@ module RokuBuilder
       parser.on("--config-dir", "Use custom directory for config json (eg.: '#{default_config_dir('<type>')}')") do |d|
         options[:config_dir] = d
       end
+      parser.on("--with-tests", "Add unit tests") do |d|
+        options[:with_tests] = true
+      end
+      parser.on("--only-tests", "Only unit tests") do |d|
+        options[:only_tests] = true
+        options[:with_tests] = true
+      end
+      parser.on("--tests-dir", "Use custom directory for unit tests (eg.: '#{default_unitTests_dir('<type>')}')") do |d|
+        options[:tests_dir] = d
+      end
       parser.on("--dry-run", "Do not write files, just output") do |d|
         options[:dry_run] = true
       end
@@ -130,7 +152,6 @@ module RokuBuilder
 
     def component_has_config_json(component_type)
       ['module', 'screen', 'manager'].include? component_type
-
     end
 
     def generate(options:)
@@ -145,7 +166,7 @@ module RokuBuilder
       component_name_parts = options[:name].split('/')
       component_proper_name = capitalizeFirst(component_name_parts.last)
       component_parent_dir = component_name_parts.first(component_name_parts.size-1).join('/')
-      brand = brand.downcase
+      brand =  options[:brand].downcase
 
       component_name = get_file_name(component_type, component_proper_name)
       component = RokuBuilderGenerator::BrsComponent.new(component_name, options[:extends], component_type, @logger)
@@ -153,27 +174,52 @@ module RokuBuilder
       brs_text = component.render("brs")
       json_text = options[:with_config] && component_has_config_json(component_type) ? component.render("json") : nil
 
+      test_xml_text = options[:with_tests] ? component.renderTest("xml") : nil
+      test_brs_text = options[:with_tests] ? component.renderTest("brs") : nil
+      testSetup_brs_text = options[:with_tests] ? component.renderTestSetup() : nil
+
       output_dir = get_output_dir(component_type, component_name, brand, component_parent_dir, options[:custom_dir], config[:component_dir])
       output_config_dir = get_config_output_dir(component_type,  brand, options[:config_dir])
       output_file_name = File.join(output_dir, component_name)
       output_config_file_name = File.join(output_config_dir, component_proper_name)
 
+      output_unitTests_dir = get_unitTests_output_dir(component_type, component_proper_name, options[:tests_dir])
+
+      test_component_name= "Test_"+component_proper_name
+
+      output_test_file_name = File.join(output_unitTests_dir, test_component_name)
+      output_test_setup_file_name= File.join(output_unitTests_dir, test_component_name+"_Setup")
+
       if(options[:dry_run])
         @logger.unknown "Dry Run, not writing files"
         show_line()
-        display_file(output_file_name+".xml", xml_text)
-        display_file(output_file_name+".brs", brs_text)
-        display_file(output_config_file_name+".json", json_text)
+        unless options[:only_tests]
+          display_file(output_file_name+".xml", xml_text)
+          display_file(output_file_name+".brs", brs_text)
+          display_file(output_config_file_name+".json", json_text)
+        end
+
+        display_file(output_test_file_name+".xml", test_xml_text)
+        display_file(output_test_file_name+".brs", test_brs_text)
+        display_file(output_test_setup_file_name+".brs", testSetup_brs_text)
       else
         @logger.unknown "Writing files"
         show_line()
-        FileUtils.mkdir_p output_dir
-        unless json_text.nil?
-          FileUtils.mkdir_p output_config_dir
+        unless options[:only_tests]
+          FileUtils.mkdir_p output_dir
+          unless json_text.nil?
+            FileUtils.mkdir_p output_config_dir
+          end
+          write_file(output_file_name+".xml", xml_text)
+          write_file(output_file_name+".brs", brs_text)
+          write_file(output_config_file_name+".json", json_text)
+        end
+        unless test_xml_text.nil?
+          FileUtils.mkdir_p output_unitTests_dir
         end
-        write_file(output_file_name+".xml", xml_text)
-        write_file(output_file_name+".brs", brs_text)
-        write_file(output_config_file_name+".json", json_text)
+        write_file(output_test_file_name+".xml", test_xml_text)
+        write_file(output_test_file_name+".brs", test_brs_text)
+        write_file(output_test_setup_file_name+".brs", testSetup_brs_text)
       end
     end
 

data/lib/roku_builder_generator/brs_component.rb

@@ -27,6 +27,26 @@ module RokuBuilderGenerator
       return nil
     end
 
+    def renderTest(file_type)
+      file_name = get_template_name("test", file_type)
+
+      unless file_name.nil?
+        template = File.read(file_name)
+        return render_template(template)
+      end
+      return nil
+    end
+
+    def renderTestSetup()
+      file_name = get_template_name("test_Setup", "brs")
+
+      unless file_name.nil?
+        template = File.read(file_name)
+        return render_template(template)
+      end
+      return nil
+    end
+
     def log(message)
       unless @logger.nil?
         @logger.info message

data/lib/roku_builder_generator/templates/test.brs.erb

@@ -0,0 +1,6 @@
+sub init()
+  Runner = TestRunner()
+  Runner.SetFunctions([
+    TestSuite__<%= name %>_Setup
+  ])
+end sub

data/lib/roku_builder_generator/templates/test.xml.erb

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- ##COPYRIGHT HEADER## -->
+
+<component name="Test_<%= name %>" extends="<%= name %>">
+  <!--     Function, used by framework, to run tests. Should not be called manually! -->
+  <interface>
+    <function name="TestFramework__RunNodeTests"/>
+  </interface>
+
+  <!--     Import test suites. -->
+  <script type="text/brightscript" uri="Test_<%= name %>.brs" />
+  <script type="text/brightscript" uri="Test_<%= name %>_Setup.brs" />
+
+  <!--     Import test framework. -->
+  <script type="text/brightscript" uri="pkg:/source/UnitTestFramework.brs"/>
+</component>

data/lib/roku_builder_generator/templates/test_Setup.brs.erb

@@ -0,0 +1,20 @@
+function TestSuite__<%= name %>_Setup()
+  ' Inherit your test suite from BaseTestSuite
+  this = BaseTestSuite()
+
+  ' Test suite name for log statistics
+  this.Name = "TestSuite_<%= name %>_Setup"
+
+  ' Add tests to suite's tests collection
+  this.addTest("TestCase_Config_Exists", TestCase_Config_Exists)
+
+  return this
+end function
+
+function TestCase_Config_Exists()
+  config = getGlobalAA().channelConfig
+  top = getGlobalAA().top
+
+  m.assertNotInvalid(config)
+  return m.assertNotInvalid(top)
+end function

data/lib/roku_builder_generator/version.rb

@@ -1,4 +1,4 @@
 module RokuBuilderGenerator
   NAME = "roku_builder_generator"
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Mark Pearce
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roku_builder
@@ -58,13 +58,16 @@ files:
 - lib/roku_builder_generator/templates/manager.brs.erb
 - lib/roku_builder_generator/templates/module.xml.erb
 - lib/roku_builder_generator/templates/screen.xml.erb
+- lib/roku_builder_generator/templates/test.brs.erb
+- lib/roku_builder_generator/templates/test.xml.erb
+- lib/roku_builder_generator/templates/test_Setup.brs.erb
 - lib/roku_builder_generator/utils.rb
 - lib/roku_builder_generator/version.rb
 - roku_builder_generator.gemspec
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: RokuBuilder Generator Plugin
 test_files: []