roku_builder_generator 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0204f922e4434a1a0c814410ba2d655c82e771edbd1175a1705a689185a0819
-  data.tar.gz: 36650f221ae40b8903153f840536254853362d3e207e06f6e52d5d0fb8e3b8a0
+  metadata.gz: 50d50e79d829314444a02c6dfea8082c609185b2efdd0951c33f754daa6fcbda
+  data.tar.gz: 4ecb281d387c3eb92fa9dd345a75670ba2596d98dc831748a4cbe4842122cb69
 SHA512:
-  metadata.gz: 4bf23c381e6473c46bdfb0866cc6f5f252948f0da310cee0b18fcecf7508f5a12662f355acbc1446cbac20ac704163137a55a7119dee394cc1c2c7813c244497
-  data.tar.gz: a17b132d2a5035afa12522e87e14710b6c239df97fc6143925849120c4e5e1aabf26c9042db4173f0be3528073160c204aed452af927a2007feefd592eb42eaa
+  metadata.gz: 226244599f730ae30f767a8473c48e9d416e0579b1e4ba643db134afd1fc2cd942210bb6dd80434735618f4fbd82f549314a9273bd789761bd501b9f8afded2c
+  data.tar.gz: 8e0a6d16062f870f60107977ad63a43e71945ede45d6d6aa7db5dd643d8efe4a3290b71efab6c1eac057799eaeda4dbc28755c040798ea1caab26e5e9dd8bab7

data/Gemfile

@@ -2,5 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in roku_builder_generator.gemspec
 gemspec
-
-gem 'solargraph', group: :development

data/README.md

@@ -25,10 +25,16 @@ Options for RokuBuilder::Generator:
 Commands:
         --generate COMPONENT_TYPE    Generate a component: manager, module, task, screen
         --name COMPONENT_NAME        Name of the component
+Options:
         --extends COMPONENT_NAME     A component to extend
-        --base-dir                   Base directory for generated code (eg.: 'brands/core/components/<type>s')
+        --for-brand BRAND            Brand to put component in (default:' core')
+        --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
@@ -41,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`
@@ -49,12 +59,45 @@ Format of config file:
 
 ```js
 {
-  "component_dir": "base/directory/for/components", // default: "./brands/core/components"
-  "config_dir": "base/directory/for/config/json/files", // default: "./brands/core/region/US/configs"
+  "component_dir": "base/directory/for/components", // default: "./brands/%brand%/components"
+  "config_dir": "base/directory/for/config/json/files", // default: "./brands/%brand%/region/US/configs"
   "template_dir": "directory/for/templates" // default: "./roku_builder_generator"
 }
 ```
 
+### Directories and Brands
+
+Unless you specify a custom directory, generated files will be placed in the default directory. For example,
+`roku --generate manager --name foo --with-config`
+will generate the following files:
+
+- ./brands/core/components/Managers/FooManager/FooManager.xml
+- ./brands/core/components/Managers/FooManager/FooManager.brs
+- ./brands/core/region/US/configs/Managers/Foo.json
+
+without specifying custom directories, files can be generated for other brands. For example,
+
+`roku --generate manager --name foo --for-brand comedy --with-config`
+
+will generate:
+
+- ./brands/comedy/components/Managers/FooManager/FooManager.xml
+- ./brands/comedy/components/Managers/FooManager/FooManager.brs
+- ./brands/comedy/region/US/configs/Managers/Foo.json
+
+To enable changing brands for directories specified in `.roku_builder_generator.json`, use `%brand%` in the position where the brand should be replaced.
+
+For example, if you specify `"component_dir": "some/directory/%brand%/components"` and you ran the command
+
+`roku --generate manager --name foo --for-brand my-brand`
+
+it would generate files
+
+- ./some/directory/my-brand/components/Managers/FooManager/FooManager.xml
+- ./some/directory/my-brand/components/Managers/FooManager/FooManager.brs
+
+Note: If nothing is specified by the `--for-brand` option, it will use "core".
+
 ### Custom Templates
 
 You can add custom templates for different component types by adding [ERB](https://www.stuartellis.name/articles/erb/) files to the template directory (either `./roku_builder_generator` or whatever was defined in the config).

data/lib/roku_builder/plugins/generator.rb

@@ -5,23 +5,36 @@ require_relative '../../roku_builder_generator'
 
 def default_config()
   return {
-    :component_dir => "brands/core/components",
-    :config_dir => "brands/core/region/US/configs",
+    :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
 
-def default_output_dir(component_type, base_dir = nil)
+def default_output_dir(component_type, brand = 'core', base_dir = nil)
   base_dir = base_dir || default_config[:component_dir]
+  base_dir = replace_brand(base_dir, brand)
   return "#{base_dir}/#{component_type.capitalize()}s"
 end
 
-def default_config_dir(component_type, base_dir = nil)
+def default_config_dir(component_type, brand = 'core', base_dir = nil)
   base_dir = base_dir || default_config[:config_dir]
-   return "#{base_dir}/#{component_type.capitalize()}s"
+  base_dir = replace_brand(base_dir, brand)
+  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
+  return directory
+end
+
 module RokuBuilder
 
   class Generator < Util
@@ -43,20 +56,24 @@ module RokuBuilder
     end
 
 
-    def get_output_dir( component_type, component_name, parent_dir = nil, custom_dir = nil, base_component_dir = nil )
+    def get_output_dir( component_type, component_name, brand, parent_dir = nil, custom_dir = nil, base_component_dir = nil )
       output_dir = get_directory_name(component_type, component_name)
       unless parent_dir.nil? || "" === parent_dir
         output_dir = parent_dir+"/"+output_dir
       end
-      base_dir = custom_dir ? custom_dir : default_output_dir(component_type, base_component_dir)
+      base_dir = !custom_dir.nil? ? replace_brand(custom_dir, brand) : default_output_dir(component_type, brand, base_component_dir)
       return "./#{base_dir}/#{output_dir}"
 
     end
 
-    def get_config_output_dir( component_type, custom_dir = nil, base_config_dir = nil )
-      base_dir = custom_dir ? custom_dir : default_config_dir(component_type, base_config_dir)
+    def get_config_output_dir( component_type, brand, custom_dir = nil )
+      base_dir = !custom_dir.nil? ? replace_brand(custom_dir, brand) : default_config_dir(component_type, brand)
       return "./#{base_dir}"
+    end
 
+    def get_unitTests_output_dir(component_type, custom_dir = nil )
+      base_dir = !custom_dir.nil? ? custom_dir : default_unitTests_dir(component_type)
+      return "./#{base_dir}"
     end
 
     # Hook to add options to the parser
@@ -64,16 +81,21 @@ module RokuBuilder
     #   hash
     def self.parse_options(parser:,  options:)
       parser.separator "Commands:"
+      options[:brand] = 'core'
       parser.on("--generate COMPONENT_TYPE", "Generate a component: manager, module, task, screen") do |component_type|
         options[:generate] = component_type
       end
       parser.on("--name COMPONENT_NAME", "Name of the component") do |component_name|
         options[:name] = component_name
       end
+      parser.separator "Options:"
       parser.on("--extends COMPONENT_NAME", "A component to extend") do |component_name|
        options[:extends] = component_name
       end
-      parser.on("--base-dir", "Base directory for generated code (eg.: '#{default_output_dir('<type>')}')") do |base_dir|
+      parser.on("--for-brand BRAND", "Brand to put component in (default:' core')") do |brand|
+        options[:brand] = brand
+      end
+      parser.on("--base-dir", "Base directory for generated brs/xml code (eg.: '#{default_output_dir('<type>')}')") do |base_dir|
         options[:custom_dir] = base_dir
       end
       parser.on("--with-config", "Add empty config JSON") do |d|
@@ -82,6 +104,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
@@ -96,9 +128,11 @@ module RokuBuilder
       #Setup
     end
 
+    def capitalizeFirst(name)
+      name.slice(0,1).capitalize + name.slice(1..-1)
+    end
 
     def get_file_name(component_type, name)
-      name = name.slice(0,1).capitalize + name.slice(1..-1)
       if(component_type == 'screen' && !name.end_with?("Screen"))
         return name+ "Screen"
       end
@@ -109,7 +143,6 @@ module RokuBuilder
     end
 
     def get_directory_name(component_type, name)
-      name = name.slice(0,1).capitalize + name.slice(1..-1)
       if(component_type === 'manager'&& !name.end_with?("Manager"))
         return name+'Manager'
       end
@@ -118,7 +151,6 @@ module RokuBuilder
 
     def component_has_config_json(component_type)
       ['module', 'screen', 'manager'].include? component_type
-
     end
 
     def generate(options:)
@@ -131,8 +163,9 @@ module RokuBuilder
       config = read_config()
       component_type = options[:generate].downcase
       component_name_parts = options[:name].split('/')
-      component_proper_name = component_name_parts.last
+      component_proper_name = capitalizeFirst(component_name_parts.last)
       component_parent_dir = component_name_parts.first(component_name_parts.size-1).join('/')
+      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)
@@ -140,27 +173,52 @@ module RokuBuilder
       brs_text = component.render("brs")
       json_text = options[:with_config] && component_has_config_json(component_type) ? component.render("json") : nil
 
-      output_dir = get_output_dir(component_type, component_name, component_parent_dir, options[:custom_dir], config[:component_dir])
-      output_config_dir = get_config_output_dir(component_type, options[:config_dir], config[:config_dir])
+      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, options[:config_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
-        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)
+        unless test_xml_text.nil?
+          FileUtils.mkdir_p output_unitTests_dir
+        end
+        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
 
@@ -176,7 +234,11 @@ module RokuBuilder
     def write_file(output_file_name, contents)
       unless contents.nil?
         @logger.unknown output_file_name
-        File.open(output_file_name, "w") { |f| f.write contents }
+        if File.exist?(output_file_name)
+          @logger.warn "#{output_file_name} already exists, skipping"
+        else
+          File.open(output_file_name, "w") { |f| f.write contents }
+        end
       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.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_Example()
+  config = getGlobalAA().channelConfig
+  codebox = getGlobalAA().codebox
+
+  m.assertNotInvalid(config)
+  m.assertNotInvalid(codebox)
+end function

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/version.rb

@@ -1,4 +1,4 @@
 module RokuBuilderGenerator
   NAME = "roku_builder_generator"
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Pearce
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2022-03-28 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.setup.brs.erb
+- lib/roku_builder_generator/templates/test.xml.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: []