roku_builder_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0204f922e4434a1a0c814410ba2d655c82e771edbd1175a1705a689185a0819
+  data.tar.gz: 36650f221ae40b8903153f840536254853362d3e207e06f6e52d5d0fb8e3b8a0
+SHA512:
+  metadata.gz: 4bf23c381e6473c46bdfb0866cc6f5f252948f0da310cee0b18fcecf7508f5a12662f355acbc1446cbac20ac704163137a55a7119dee394cc1c2c7813c244497
+  data.tar.gz: a17b132d2a5035afa12522e87e14710b6c239df97fc6143925849120c4e5e1aabf26c9042db4173f0be3528073160c204aed452af927a2007feefd592eb42eaa

data/.gitignore

@@ -0,0 +1,11 @@
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2020 Viacom, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,66 @@
+# RokuBuilderGenerator
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'roku_builder_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roku_builder_generator
+
+## Usage
+
+The generator plugin has the following commands:
+
+```
+Options for RokuBuilder::Generator:
+Commands:
+        --generate COMPONENT_TYPE    Generate a component: manager, module, task, screen
+        --name COMPONENT_NAME        Name of the component
+        --extends COMPONENT_NAME     A component to extend
+        --base-dir                   Base directory for generated 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')
+```
+
+### Examples
+
+Generate a manager called "FooManager", with an empty configuration JSON file:
+
+`roku --generate manager --name foo --with-config`
+
+Generate a task ("Bar"), but just display the output on screen:
+
+`roku --generate task --name bar --dry-run -V`
+
+### Config
+
+You can supplement the default configuration using a local file `.roku_builder_generator.json`
+
+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"
+  "template_dir": "directory/for/templates" // default: "./roku_builder_generator"
+}
+```
+
+### 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).
+
+The template file name must be of the form `<component_name>.<file_extension>.erb`
+
+For example, to add a custom template for module SceneGraph XML files, create the file:
+
+`./roku_builder_generator/module.xml.erb`

data/lib/roku_builder/plugins/generator.rb

@@ -0,0 +1,211 @@
+require 'erb'
+require 'fileutils'
+require_relative '../../roku_builder_generator'
+
+
+def default_config()
+  return {
+    :component_dir => "brands/core/components",
+    :config_dir => "brands/core/region/US/configs",
+    :template_dir => "roku_builder_generator"
+  }
+end
+
+def default_output_dir(component_type, base_dir = nil)
+  base_dir = base_dir || default_config[:component_dir]
+  return "#{base_dir}/#{component_type.capitalize()}s"
+end
+
+def default_config_dir(component_type, base_dir = nil)
+  base_dir = base_dir || default_config[:config_dir]
+   return "#{base_dir}/#{component_type.capitalize()}s"
+end
+
+
+module RokuBuilder
+
+  class Generator < Util
+    extend Plugin
+
+
+
+    # Hash of commands
+    # Each command defines a hash with three optional values
+    # Setting device to true will require that there is an avaiable device
+    # Setting source to true will require that the user passes a source option
+    #   with the command
+    # Setting stage to true will require that the user passes a stage option
+    #   with the command
+    def self.commands
+      {
+        generate: {}
+      }
+    end
+
+
+    def get_output_dir( component_type, component_name, 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)
+      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)
+      return "./#{base_dir}"
+
+    end
+
+    # Hook to add options to the parser
+    # The keys set in options for commands must match the keys in the commands
+    #   hash
+    def self.parse_options(parser:,  options:)
+      parser.separator "Commands:"
+      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.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|
+        options[:custom_dir] = base_dir
+      end
+      parser.on("--with-config", "Add empty config JSON") do |d|
+        options[:with_config] = true
+      end
+      parser.on("--config-dir", "Use custom directory for config json (eg.: '#{default_config_dir('<type>')}')") do |d|
+        options[:config_dir] = d
+      end
+      parser.on("--dry-run", "Do not write files, just output") do |d|
+        options[:dry_run] = true
+      end
+    end
+
+    # Array of plugins the this plugin depends on
+    def self.dependencies
+      []
+    end
+
+    def init
+      #Setup
+    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
+      if(component_type === 'manager'&& !name.end_with?("Manager"))
+        return name+'Manager'
+      end
+      return name
+    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
+      return name
+    end
+
+    def component_has_config_json(component_type)
+      ['module', 'screen', 'manager'].include? component_type
+
+    end
+
+    def generate(options:)
+      if(!options[:name])
+        raise InvalidOptions, "Missing component name"
+      end
+      if(!options[:generate])
+        raise InvalidOptions, "Missing component type"
+      end
+      config = read_config()
+      component_type = options[:generate].downcase
+      component_name_parts = options[:name].split('/')
+      component_proper_name = component_name_parts.last
+      component_parent_dir = component_name_parts.first(component_name_parts.size-1).join('/')
+
+      component_name = get_file_name(component_type, component_proper_name)
+      component = RokuBuilderGenerator::BrsComponent.new(component_name, options[:extends], component_type, @logger)
+      xml_text = component.render("xml")
+      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])
+      output_file_name = File.join(output_dir, component_name)
+      output_config_file_name = File.join(output_config_dir, component_proper_name)
+
+      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)
+      else
+        @logger.unknown "Writing files"
+        show_line()
+        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
+    end
+
+
+    def display_file(output_file_name, contents)
+      unless contents.nil?
+        @logger.unknown output_file_name
+        @logger.info "\n"+ contents
+        show_line
+      end
+    end
+
+    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 }
+      end
+    end
+
+    def show_line
+      @logger.info  "------"
+    end
+
+    def config_path()
+      config_json_file =  "./.roku_builder_generator.json"
+      unless File.exist?(config_json_file)
+        @logger.warn "Missing Generator Config File (#{config_json_file}) - using default values"
+        return nil
+      end
+      return config_json_file
+    end
+
+    def read_config()
+      config = default_config
+      unless config_path.nil?
+        File.open(config_path) do |io|
+          config.merge!(JSON.parse(io.read, {symbolize_names: true}))
+        end
+      end
+      config
+    end
+
+  end
+
+
+# Register your plugin
+  RokuBuilder.register_plugin(Generator)
+end

data/lib/roku_builder_generator/brs_component.rb

@@ -0,0 +1,62 @@
+require 'erb'
+require_relative "./utils"
+
+module RokuBuilderGenerator
+
+  class BrsComponent
+    include ERB::Util
+
+    attr_accessor :name, :extends, :template_type
+
+
+    def initialize(name, extends, template_type, logger = nil, local_file_dir = nil)
+      @name = name
+      @extends = extends
+      @template_type = template_type
+      @logger = logger
+      @local_file_dir = local_file_dir || RokuBuilderGenerator::NAME
+    end
+
+    def render(file_type)
+      file_name = get_template_name(@template_type, file_type)
+
+      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
+      else
+        puts message
+      end
+    end
+
+    def get_template_name(template_type, file_type)
+      file_name =  "#{template_type}.#{file_type}.erb"
+      local_file = "./#{@local_file_dir}/#{file_name}"
+      gem_file = RokuBuilderGenerator::Utils.gem_libdir+"/templates/#{file_name}"
+      if File.exist?(local_file)
+        log "#{file_type}: Using local version of template - #{local_file}"
+        return local_file
+      elsif  File.exist?(gem_file)
+        log "#{file_type}: Using gem version of template - #{gem_file}"
+        return gem_file
+      end
+      if template_type === "default"
+        return nil
+      end
+      return get_template_name("default", file_type)
+    end
+
+    def render_template(template)
+      return ERB.new(template).result(binding)
+    end
+
+
+  end
+
+end

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

@@ -0,0 +1,10 @@
+'##COPYRIGHT HEADER##
+
+
+' <%= name %>
+'
+' @since version
+
+sub init()
+
+end sub

data/lib/roku_builder_generator/templates/default.json.erb

@@ -0,0 +1,4 @@
+{
+  "<%= name %>": {
+  }
+}

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

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- ##COPYRIGHT HEADER## -->
+
+<component name="<%= name %>"<% if !extends.nil? %> extends="<%= extends %>"<% end %>>
+  <script type="text/brightscript" uri="<%= name %>.brs" />
+
+  <interface>
+  </interface>
+
+</component>

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

@@ -0,0 +1,10 @@
+'##COPYRIGHT HEADER##
+
+
+' <%= name %>
+'
+' @since version
+
+sub completeSetup()
+
+end sub

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

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- ##COPYRIGHT HEADER## -->
+
+<component name="<%= name %>"<% if !extends.nil? %> extends="<%= extends %>"<% end %>>
+  <script type="text/brightscript" uri="<%= name %>.brs" />
+
+  <interface>
+  </interface>
+
+  <children>
+  </children>
+
+</component>

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

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- ##COPYRIGHT HEADER## -->
+
+<component name="<%= name %>"<% if !extends.nil? %> extends="<%= extends %>"<% end %>>
+  <script type="text/brightscript" uri="<%= name %>.brs" />
+
+  <interface>
+  </interface>
+
+  <children>
+    <Group id="screenContainer">
+    </Group>
+  </children>
+
+</component>

data/lib/roku_builder_generator/utils.rb

@@ -0,0 +1,16 @@
+module RokuBuilderGenerator
+  module Utils
+
+    # Return a directory with the project libraries.
+    def self.gem_libdir
+
+      t = ["#{File.dirname(__FILE__)}",
+           "#{File.dirname(File.expand_path($0))}/../lib/#{RokuBuilderGenerator::NAME}",
+           "#{Gem.dir}/gems/#{RokuBuilderGenerator::NAME}-#{RokuBuilderGenerator::VERSION}/lib/#{RokuBuilderGenerator::NAME}"]
+      t.each {|i| return i if File.readable?(i) }
+      raise "All paths are invalid: #{t}"
+    end
+
+    # [...]
+  end
+end

data/lib/roku_builder_generator/version.rb

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

data/lib/roku_builder_generator.rb

@@ -0,0 +1,8 @@
+
+require_relative "roku_builder_generator/version"
+require_relative "roku_builder_generator/utils"
+require_relative "roku_builder_generator/brs_component"
+
+
+module RokuBuilderGenerator
+end

data/roku_builder_generator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "roku_builder_generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "roku_builder_generator"
+  spec.version       = RokuBuilderGenerator::VERSION
+  spec.authors       = ["Mark Pearce"]
+  spec.email         = ["mark.pearce@redspace.com"]
+
+  spec.summary       = %q{RokuBuilder Generator Plugin}
+  spec.description   = %q{Plugin for RokuBuilder to do code generation for Brightscript}
+  spec.homepage      = ""
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "roku_builder", "~> 4.4"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: roku_builder_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Pearce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roku_builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Plugin for RokuBuilder to do code generation for Brightscript
+email:
+- mark.pearce@redspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/roku_builder/plugins/generator.rb
+- lib/roku_builder_generator.rb
+- lib/roku_builder_generator/brs_component.rb
+- lib/roku_builder_generator/templates/default.brs.erb
+- lib/roku_builder_generator/templates/default.json.erb
+- lib/roku_builder_generator/templates/default.xml.erb
+- 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/utils.rb
+- lib/roku_builder_generator/version.rb
+- roku_builder_generator.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: RokuBuilder Generator Plugin
+test_files: []