origen_app_generators 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c72ec7c295367269fb14603d3d5e0685e27c1302
-  data.tar.gz: 2b017360b1a782945a2bd950c07667eb4f12951f
+  metadata.gz: 6bd751932ba648a39c5f1b2d8cd61d1cc224d739
+  data.tar.gz: a71ffc595f1da44df412126be1bcaf68e5f369e7
 SHA512:
-  metadata.gz: 4b8a4fafa1c1f106b10dcc34311277e7fe986dcc5d65c485e4e0a9135b69bd0d41a5ee2e54a20619687b23fbb68be0047c8e599d97402ad096c7024dc6fa5463
-  data.tar.gz: 7575ca6ad90c50c62fc4561cf608f2c7c36423dd3d8d29a73a8206ab064346a4ab55d01c2ef205002a7b6da5f8c0b8952e2dd717535b5a9a64600292f23eac58
+  metadata.gz: 3990cdbb27929fb3fe39665776ddd6ad2d559ff8ba65c158e9761fe47aa8f004b1bd9ba8142a8721d4103c4e4e6c0f492ed23671a3cd105e5ae03d479160699b
+  data.tar.gz: 442e825f3e580a2edb99c5c32584f69c6665fc5db5015812ed5ece72bf7353ce7a10576554ecb6fef7c8f6f5440ac4402ce0d36b3f46024d07cf018b4b9db3e5

data/{lib/tasks → bin}/boot.rb

@@ -5,34 +5,34 @@
 # that any unintended dependencies on a real app environment will
 # be highlighted during test.
 
-# Path to Origen lib dir must be supplied as first arg
-$LOAD_PATH.unshift ARGV[0]
-$LOAD_PATH.unshift "#{File.expand_path(File.dirname(__FILE__))}/../"
+$LOAD_PATH.unshift ARGV.shift
+$LOAD_PATH.unshift ARGV.shift
+$LOAD_PATH.unshift ARGV.shift
 
 require 'fileutils'
+require 'origen'
 
 # Prevent the bundle from loading by running this outside of the
-if RUBY_PLATFORM == 'i386-mingw32'
-  tmp_dir = 'C:/tmp/origen_app_generators/new_app'
+if Origen.os.windows?
+  tmp_dir = 'C:/tmp/my_app_generators/new_app'
 else
-  tmp_dir = '/tmp/origen_app_generators/new_app'
+  tmp_dir = '/tmp/my_app_generators/new_app'
 end
 FileUtils.rm_rf tmp_dir if File.exist?(tmp_dir)
 FileUtils.mkdir_p tmp_dir
 
 begin
-  require 'origen'
   Dir.chdir tmp_dir do
-    # For some reason this is not being defined by required origen anymore
+    # For some reason this is not being defined by require origen anymore
     User = Origen::Users::User unless defined? User
-    gem 'byebug'
+    require 'byebug'
     require 'origen_app_generators'
-    if ARGV[1] == 'invoke'
-      OrigenAppGenerators.invoke('tmp')
-    else
-      eval(ARGV[1]).start ['tmp']
-    end
+    load_generators = ARGV.shift
+    OrigenAppGenerators.unload_generators unless ARGV[0]
+    require load_generators if File.exist?(load_generators)
+
+    OrigenAppGenerators.invoke('tmp')
   end
 ensure
-  system "mv #{tmp_dir}/tmp tmp"
+  FileUtils.mv "#{tmp_dir}/tmp", 'tmp' if File.exist?("#{tmp_dir}/tmp")
 end

data/bin/fix_my_workspace

@@ -2,9 +2,17 @@
 $VERBOSE = nil  # Don't care about world writable dir warnings and the like
 
 if $_fix_my_workspace_version_check
-  $_fix_my_workspace_version = '0.6.0'
+  $_fix_my_workspace_version = '0.7.0'
 else
-  require 'origen'
+  if File.exist?(File.expand_path('../../lib/origen.rb', __FILE__))
+    # If this script is being run from within an origen-core workspace, use that Origen-core,
+    # not the system-installed origen-core version.
+    $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+    require 'origen'
+  else
+    # Use system-installed Origen (the gem in system Ruby)
+    require 'origen'
+  end
 
   if !Origen.site_config.gem_manage_bundler
     puts 'Sorry but you have opted to manage Bundler yourself via your Origen site config, and this means'

data/config/application.rb

@@ -37,6 +37,13 @@ class OrigenAppGeneratorsApplication < Origen::Application
   # In parallel go and edit config/version.rb to enable the semantic version code.
   config.semantically_version = true
 
+  config.shared = {
+    #patterns: "pattern",
+    #templates: "templates",
+    #programs: "program",
+    command_launcher: "config/shared_commands.rb"
+  }
+
   # An example of how to set application specific LSF parameters
   #config.lsf.project = "msg.te"
   

data/config/shared_commands.rb

@@ -0,0 +1,170 @@
+# The requested command is passed in here as @command
+case @command
+
+when "app_gen:test"
+  options = {}
+
+  opt_parser = OptionParser.new do |opts|
+    opts.banner = <<-END
+Test the generators by emulating the 'origen new' command execution and building the new
+application into the tmp directory.
+
+Usage: origen app_gen:test [options]
+END
+    opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
+    opts.on('-i', '--inputs INDEX', Integer, "Apply the set of test inputs defined in #{Origen.app.namespace}::TEST_INPUTS[INDEX]") { |f| options[:inputs] = f }
+    opts.on('-r', '--regression', "Run all sets of test inputs defined in #{Origen.app.namespace}::TEST_INPUTS[INDEX]") { options[:regression] = true }
+    opts.on('-a', '--all_generators', "Include the generators from Origen core") { options[:all_generators] = true }
+    opts.separator ''
+    opts.on('-h', '--help', 'Show this message') { puts opts; exit }
+  end
+
+  opt_parser.orig_parse! ARGV
+
+  FileUtils.rm_rf "#{Origen.root}/tmp" if File.exist?("#{Origen.root}/tmp")
+
+  if options[:inputs] || options[:regression]
+    if options[:regression]
+      inputs = Origen.app.namespace.constantize::TEST_INPUTS
+    else
+      inputs = [Origen.app.namespace.constantize::TEST_INPUTS[options[:inputs].to_i]]
+    end
+
+    prefix = 'bundle exec ' unless Origen.site_config.gem_manage_bundler
+
+    overall_fail = false
+
+    inputs.each do |vals|
+      test_failed = false
+      post_build_operations = Array(vals.pop)
+      target_load_test_required = false
+      post_build_operations = post_build_operations.map do |op|
+        if op.to_s == 'default'
+          target_load_test_required = true
+          ['origen -v',
+           'origen lint --no-correct',
+           'bundle exec rake new_app_tests:load_target',
+           'origen web compile --no-serve'
+          ]
+        elsif op.to_s == 'load_target'
+          target_load_test_required = true
+          'rake new_app_tests:load_target'
+        else
+          op
+        end
+      end.flatten
+
+      str = vals.map { |i| i == :default ? "\n" : "#{i}\n" }.join('')
+      cmd = "#{prefix} origen app_gen:test"
+      cmd += ' --debugger' if options[:debugger]
+      cmd += ' --all_generators' if options[:all_generators]
+      passed = false
+      Bundler.with_clean_env do
+        passed = system "echo '#{str}' | #{cmd}"
+      end
+
+      if passed
+        # The app is successfully built, now see if it works...
+        unless post_build_operations.empty?
+          if target_load_test_required
+            FileUtils.cp "#{Origen.root!}/lib/tasks/new_app_tests.rake", 'tmp/lib/tasks'
+          end
+
+          operation_failed = false
+          Bundler.with_clean_env do
+            Dir.chdir "#{Origen.root}/tmp" do
+              post_build_operations.each_with_index do |op, i|
+                if i == 0 && !Origen.site_config.gem_manage_bundler
+                  system('bundle')
+                end
+                Origen.log.info "Running command: #{op}"
+                if system("#{prefix}#{op}")
+                  Origen.log.success "Command passed: #{op}"
+                else
+                  Origen.log.error "Command failed: #{op}"
+                  operation_failed = true
+                end
+              end
+            end
+          end
+
+          if operation_failed
+            if options[:regression]
+              overall_fail = true
+            else
+              Origen.app.stats.report_fail
+              exit 1
+            end
+          end
+        end
+      else
+        Origen.log.error "The generator failed to build!"
+        if options[:regression]
+          overall_fail = true
+        else
+          Origen.app.stats.report_fail
+          exit 1
+        end
+      end
+    end
+
+    if options[:regression] && overall_fail
+      Origen.app.stats.report_fail
+      exit 1
+    else
+      Origen.app.stats.report_pass
+      exit 0
+    end
+
+  else
+
+    # Launch the generator in a standalone shell, 
+    # this is to emulate how it will run in real life and cause it to fail if there are
+    # any dependencies on running within an Origen app environment
+    boot = "#{Origen.root!}/bin/boot.rb"
+    origen_lib = "#{Origen.top}/lib"
+    app_gen_lib = "#{Origen.root!}/lib"
+    app_lib = "#{Origen.root}/lib"
+    load_generators = "#{Origen.root}/config/load_generators.rb"
+    cmd = "#{boot} #{origen_lib} #{app_gen_lib} #{app_lib} #{load_generators}"
+    cmd = "#{cmd} true" if options[:all_generators] || Origen.app.name == :origen_app_generators
+    cmd = "ruby #{cmd}" if Origen.os.windows?
+    cmd = "bundle exec #{cmd}" unless Origen.site_config.gem_manage_bundler
+    # puts cmd
+    passed = false
+    Bundler.with_clean_env do
+      passed = system cmd
+    end
+    exit passed ? 0 : 1
+  end
+
+when "app_gen:new"
+  options = {}
+
+  opt_parser = OptionParser.new do |opts|
+    opts.banner = <<-END
+Create a new application generator.
+
+Usage: origen app_gen:new [options]
+END
+    opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
+    opts.separator ''
+    opts.on('-h', '--help', 'Show this message') { puts opts; exit }
+  end
+
+  opt_parser.orig_parse! ARGV
+
+  OrigenAppGenerators::New.start []
+  exit 0
+
+# Always leave an else clause to allow control to fall back through to the Origen command handler.
+# You probably want to also add the command details to the help shown via 'origen -h',
+# you can do this bb adding the required text to @plugin_commands before handing control back to
+# Origen.
+else
+  @plugin_commands << <<-EOT
+ app_gen:test Test run the 'origen new' command operation using your latest generators
+ app_gen:new  Create a new application or plugin generator
+  EOT
+
+end

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenAppGenerators
-  MAJOR = 0
-  MINOR = 4
+  MAJOR = 1
+  MINOR = 0
   BUGFIX = 0
   DEV = nil
 

data/lib/origen_app_generators.rb

@@ -1,4 +1,5 @@
 require 'origen'
+require_relative '../config/application.rb'
 require 'colored'
 require 'origen_app_generators/base'
 require 'origen_app_generators/application'
@@ -8,40 +9,71 @@ require 'origen_app_generators/empty_plugin'
 require 'origen_app_generators/new'
 require 'origen_app_generators/test_engineering/test_block'
 require 'origen_app_generators/test_engineering/stand_alone_application'
+require 'origen_app_generators/origen_infrastructure/app_generator_plugin'
 
 module OrigenAppGenerators
   extend Origen::Utility::InputCapture
 
   TEST_INPUTS = [
-    # Empty app
-    ['0', '0', :default, :default, []],
-    # Empty plugin
-    ['0', '1', :default, :default, 'A test block', 'yes', []],
-    # Stand alone test engineering app
-    ['1', '0', :default, :default, 'Falcon, Eagle', 'Falcon[ram, atd(2), comm[ram(2), osc](3)], Eagle[ram(2), atd(4)]', ['origen g example']],
-    # Test module
-    ['1', '1', :default, :default, 'Test module for all flash IPs', 'FLASH_512K, FLASH_1024K', 'flash', ['origen g example']]
-  ]
+    # 0 - Empty app
+    ['0', '0', :default, :default, :default],
+    # 1 - Empty plugin
+    ['0', '1', :default, :default, 'A test block', 'yes', :default],
+    # 2 - Stand alone test engineering app
+    ['2', '0', :default, :default, 'Falcon, Eagle', 'Falcon[ram, atd(2), comm[ram(2), osc](3)], Eagle[ram(2), atd(4)]', [:default, 'origen g example']],
+    # 3 - Test module
+    ['2', '1', :default, :default, 'Test module for all flash IPs', 'FLASH_512K, FLASH_1024K', 'flash', [:default, 'origen g example']],
+    # 4 - An app generators plugin
+    ['1', '0', :default, :default, 'My application generators', :default]
+  ] # END_OF_TEST_INPUTS Don't remove this comment, it is used by the app_gen:new command!
 
-  # If adding any new generators manually always add them at the top, but
-  # generally speaking don't, use 'rake new' to create a new generator instead
+  # As you add new generators to this app they will be entered here, this enables the
+  # mechanism to register them with the 'origen new' command.
+  # You should generally not modify this by hand, instead use the 'origen app_gen:new'
+  # command every time you want to create a new generator, and this will be filled in
+  # for you.
   AVAILABLE = {
-    'Test Engineering' => [
+    'Test Engineering'      => [
       OrigenAppGenerators::TestEngineering::TestBlock,
       OrigenAppGenerators::TestEngineering::StandAloneApplication
+    ],
+    'Origen Infrastructure' => [
+      OrigenAppGenerators::OrigenInfrastructure::AppGeneratorPlugin
     ]
   }
 
+  # @api private
+  def self.add_generators(new_generators)
+    new_generators.each do |domain, gens|
+      if generators[domain]
+        gens.each { |g| generators[domain].unshift(g) }
+        new_generators.delete(domain)
+      end
+    end
+    @generators = new_generators.merge(generators)
+  end
+
+  # @api private
+  def self.unload_generators
+    @generators = {}
+  end
+
+  # @api private
+  def self.generators
+    @generators ||= AVAILABLE
+  end
+
+  # @api private
   def self.invoke(path)
     puts
-    puts 'CHOOSE AN ENGINEERING DOMAIN'
+    puts 'CHOOSE AN APPLICATION DOMAIN'
     puts
     puts "Domain-specific application templates are available for the following areas (enter '0' to build an empty generic one)"
     puts
     i = 0
     accept = [0]
     puts '0 - Empty / Not listed'
-    AVAILABLE.reverse_each do |domain, _generators|
+    generators.reverse_each do |domain, _generators|
       i += 1
       accept << i
       puts "#{i} - #{domain}"
@@ -65,7 +97,7 @@ module OrigenAppGenerators
         OrigenAppGenerators::EmptyPlugin.start [path]
       end
     else
-      domain = AVAILABLE.to_a
+      domain = generators.to_a
       domain = domain[domain.size - selection]
       puts
       puts "CHOOSE FROM THE FOLLOWING #{domain[0].upcase} APPLICATION TEMPLATES"

data/lib/origen_app_generators/new.rb

@@ -11,6 +11,7 @@ module OrigenAppGenerators
       get_name
       get_type
       get_summary
+      @namespace = Origen.app.namespace
     end
 
     def set_type
@@ -22,56 +23,73 @@ module OrigenAppGenerators
     end
 
     def enable
-      # Add require line
-      module_declaration = /\nmodule OrigenAppGenerators/
-      inject_into_file 'lib/origen_app_generators.rb', "require 'origen_app_generators/#{@domain_namespace.underscore}/#{@classname.underscore}'\n",
+      available = Origen.app.namespace.constantize::AVAILABLE
+      test_inputs = Origen.app.namespace.constantize::TEST_INPUTS
+
+      # **** Add require line ****
+      module_declaration = /\nmodule #{Origen.app.namespace}/
+      inject_into_file "lib/#{Origen.app.name}.rb", "require '#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}'\n",
                        before: module_declaration
 
-      # Add to the AVAILABLE hash
-      if OrigenAppGenerators::AVAILABLE[@domain_summary]
+      # **** Add to the AVAILABLE hash ****
+      if available[@domain_summary]
         existing_domain = /\s*('|")#{@domain_summary}('|") => \[\s*\n/
-        inject_into_file 'lib/origen_app_generators.rb', "      OrigenAppGenerators::#{@domain_namespace}::#{@classname},\n",
+        inject_into_file "lib/#{Origen.app.name}.rb", "      #{Origen.app.namespace}::#{@domain_namespace}::#{@classname},\n",
                          after: existing_domain
       else
         new_domain = <<-END
     '#{@domain_summary}' => [
-      OrigenAppGenerators::#{@domain_namespace}::#{@classname},
+      #{Origen.app.namespace}::#{@domain_namespace}::#{@classname},
     ],
         END
         available_hash = /AVAILABLE = {\s*\n/
-        inject_into_file 'lib/origen_app_generators.rb', new_domain, after: available_hash
+        inject_into_file "lib/#{Origen.app.name}.rb", new_domain, after: available_hash
       end
-    end
 
-    # Can't compile this as contains some final ERB, so substitute instead
-    def customize_doc_page
-      file = filelist[:doc_info][:dest]
-      gsub_file file, 'TITLE_GOES_HERE', @title
-      if @type == :plugin
-        gsub_file file, 'INTRO_GOES_HERE', "This generates a customized version of the [Generic Plugin](<%= path 'origen_app_generators/plugin' %>)."
+      # **** Add a starter set of test inputs ****
+      # First work out what the selection numbers will be for the new generator
+      if available[@domain_summary]
+        first = available.size - available.find_index { |k, _| k == @domain_summary }
+        second = available[@domain_summary].size
       else
-        gsub_file file, 'INTRO_GOES_HERE', "This generates a customized version of the [Generic Application](<%= path 'origen_app_generators/application' %>)."
+        first = available.size + 1
+        second = 0
       end
+      inputs = "\n    # #{test_inputs.size} - #{@domain_namespace}::#{@classname}\n"
+      if @parentclass == 'Plugin'
+        inputs += "    ['#{first}', '#{second}', :default, :default, 'A cool plugin', 'yes', :default]"
+      else
+        inputs += "    ['#{first}', '#{second}', :default, :default, :default]"
+      end
+      inputs = ",#{inputs}" unless test_inputs.empty?
+      end_of_test_inputs = /\n\s*]\s*#\s*END_OF_TEST_INPUTS/
+      inject_into_file "lib/#{Origen.app.name}.rb", inputs, before: end_of_test_inputs
     end
 
+    # Can't compile this as contains some final ERB, so substitute instead
+    # def customize_doc_page
+    #  file = filelist[:doc_info][:dest]
+    #  gsub_file file, 'TITLE_GOES_HERE', @title
+    #  if @type == :plugin
+    #    gsub_file file, 'INTRO_GOES_HERE', "This generates a customized version of the [Generic Plugin](<%= path 'origen_app_generators/plugin' %>)."
+    #  else
+    #    gsub_file file, 'INTRO_GOES_HERE', "This generates a customized version of the [Generic Application](<%= path 'origen_app_generators/application' %>)."
+    #  end
+    # end
+
     def conclude
+      system "origen lint #{Origen.root}/lib/#{Origen.app.name}.rb"
       puts
       puts "New generator created at: #{filelist[:generator][:dest]}"
       puts
       puts "Create any template files you need for this generator in: #{filelist[:templates_dir][:dest]}"
       puts
-      puts "Before you go add some documentation about what this generates to: templates/web/origen_app_generators/origen_app_generators/#{@domain_namespace.underscore}/#{@classname.underscore}.md.erb"
-      puts
+      # puts "Before you go add some documentation about what this generates to: templates/web/origen_app_generators/origen_app_generators/#{@domain_namespace.underscore}/#{@classname.underscore}.md.erb"
+      # puts
     end
 
     protected
 
-    def existing_domains
-      OrigenAppGenerators::AVAILABLE.keys.map do |key|
-        key.sub(/ Engineering$/, '')
-      end
-    end
-
     def get_summary
       puts
       puts 'DESCRIBE YOUR NEW GENERATOR IN A FEW WORDS'
@@ -100,7 +118,7 @@ module OrigenAppGenerators
         @classname = get_text(single: true).split('::').last
         unless @classname.empty?
           if @classname.length >= 3
-            valid = valid_constant?("OrigenAppGenerators::#{@domain_namespace}::#{@classname}")
+            valid = valid_constant?("#{Origen.app.namespace}::#{@domain_namespace}::#{@classname}")
           end
           unless valid
             puts 'That class name is not valid :-('
@@ -113,24 +131,24 @@ module OrigenAppGenerators
 
     def get_domain
       puts
-      puts 'WHAT ENGINEERING DOMAIN WILL YOUR NEW APP TEMPLATE APPLY TO?'
+      puts 'WHAT APPLICATION DOMAIN WILL YOUR NEW APP TEMPLATE APPLY TO?'
       puts
-      puts "Enter something like 'Test', 'Design', 'Product', etc."
+      puts "Enter something like 'Test Engineering', 'Design', etc."
       puts
       domain = get_text(single: true)
-      domain = domain.sub(/ Engineering$/i, '').titleize
-      @domain_summary = "#{domain} Engineering"
+      domain = domain.titleize
+      @domain_summary = domain
       @domain_namespace =  @domain_summary.gsub(' ', '')
     end
 
     def filelist
       @filelist ||= {
         generator:     { source: 'generator.rb',
-                         dest:   "lib/origen_app_generators/#{@domain_namespace.underscore}/#{@classname.underscore}.rb" },
+                         dest:   "lib/#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}.rb" },
         templates_dir: { dest: "templates/app_generators/#{@domain_namespace.underscore}/#{@classname.underscore}",
                          type: :directory },
-        doc_info:      { source: 'info.md.erb',
-                         dest:   "templates/web/origen_app_generators/#{@domain_namespace.underscore}/#{@classname.underscore}.md.erb" }
+        # doc_info:      { source: 'info.md.erb',
+        #                 dest:   "templates/web/#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}.md.erb" }
       }
     end
   end

data/lib/origen_app_generators/origen_infrastructure/app_generator_plugin.rb

@@ -0,0 +1,103 @@
+module OrigenAppGenerators
+  module OrigenInfrastructure
+    # Generates a generic application shell
+    class AppGeneratorPlugin < Plugin
+      desc "A plugin to make your own application templates available through the 'origen new' command"
+
+      def initialize(*args)
+        @audience = :internal
+        @validate_release_tests = ['origen app_gen:test --regression']
+        super
+      end
+
+      # Any methods that are not protected will get invoked in the order that they are
+      # defined when the generator is run, method naming is irrelevant unless you want
+      # to override a method that is defined by the parent class
+
+      def get_user_input
+        # The methods to get the common user input that applies to all applications will
+        # get called at the start automatically, you have a chance here to ask any additional
+        # questions that are specific to the type of application being generated
+      end
+
+      def generate_files
+        @runtime_dependencies = [
+          ['origen_app_generators', ">= #{Origen.app!.version}"]
+        ]
+        @post_runtime_dependency_comments = [
+          'DO NOT ADD ANY ADDITIONAL RUNTIME DEPENDENCIES HERE, WHEN THESE GENERATORS',
+          'ARE INVOKED TO GENERATE A NEW APPLICATION IT WILL NOT BE LAUNCHED FROM WITHIN',
+          'A BUNDLED ENVIRONMENT.',
+          '',
+          'THEREFORE GENERATORS MUST NOT RELY ON ANY 3RD PARTY GEMS THAT ARE NOT',
+          'PRESENT AS PART OF A STANDARD ORIGEN INSTALLATION - I.E. YOU CAN ONLY RELY',
+          'ON THE GEMS THAT ORIGEN ITSELF DEPENDS ON.'
+        ]
+        # Calling this will build all files, directories and symlinks contained in the
+        # hash returned by the filelist method
+        build_filelist
+      end
+
+      def modify_files
+        # If you want to modify any of the generated files you can do so now, you have access
+        # to all of the Thor Action methods described here:
+        # http://www.rubydoc.info/github/wycats/thor/Thor/Actions
+        # See the enable method in lib/app_generators/new.rb for some examples of using these.
+      end
+
+      def conclude
+        # Print out anything you think the user should know about their new application at the end
+        puts "New app created at: #{destination_root}"
+        puts
+        puts 'Create your first generator by running this command within your new app:'
+        puts '  origen app_gen:new'
+        puts
+      end
+
+      protected
+
+      # Defines the filelist for the generator, the default list is inherited from the
+      # parent class (Plugin).
+      # The filelist can contain references to generate files, directories or symlinks in the
+      # new application.
+      #
+      # Generally to make your generator more maintainable try and re-use as much as possible
+      # from the parent generator, this means that your generator will automatically stay up
+      # to date with the latest conventions
+      #
+      # The master templates live in templates/app_generators/plugin, but
+      # DO NOT MODIFY THESE FILES DIRECTLY.
+      # Either add or remove things post-generation in the modify_files method or copy the
+      # master file to the equivalent sub-directory of templates/app_generators/origen_infrastructure_engineering/app_generator_plugin
+      # which will override the version in the master directory.
+      #
+      # Additional files can be added or removed from the filelist as shown below.
+      def filelist
+        @filelist ||= begin
+          list = super  # Always pick up the parent list
+          # Example of how to remove a file from the parent list
+          # list.delete(:web_doc_layout)
+          list.delete(:lib_readme)
+          list.delete(:lib_readme_dev)
+          # Example of how to add a file, in this case the file will be compiled and copied to
+          # the same location in the new app
+          # list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
+          list[:config_load_generators] = { source: 'config/load_generators.rb' }
+          list[:lib_plugin] = { source: 'lib/plugin.rb', dest: "lib/#{@name}/plugin.rb" }
+          list[:lib_application] = { source: 'lib/application.rb', dest: "lib/#{@name}/application.rb" }
+          # Alternatively specifying a different destination, typically you would do this when
+          # the final location is dynamic
+          # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
+          # Example of how to create a directory
+          # list[:pattern_dir] = { dest: "pattern", type: :directory }
+          # Example of how to create a symlink
+          # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+          #                          dest:   'target/default.rb', # Relative to destination_root
+          #                          type:   :symlink }
+          # Remember to return the final list
+          list
+        end
+      end
+    end
+  end
+end

data/lib/origen_app_generators/plugin.rb

@@ -27,7 +27,7 @@ module OrigenAppGenerators
           list[:web_navbar] = { source: 'templates/web/partials/_navbar_internal.html.erb', dest: 'templates/web/partials/_navbar.html.erb' }
         end
         list[:lib_readme] = { source: 'lib/README', dest: "lib/#{@name}/README" }
-        list[:lib_reame_dev] = { source: 'lib_dev/README', dest: "lib/#{@name}_dev/README" }
+        list[:lib_readme_dev] = { source: 'lib_dev/README', dest: "lib/#{@name}_dev/README" }
         list
       end
     end

data/lib/tasks/app_generators.rake

@@ -1,98 +1,6 @@
-desc 'Create an application generator'
-task :new do
-  OrigenAppGenerators::New.start []
-end
-
-desc 'Test run the new app process'
-task :test, [:set] do |t, args|
-  _delete_tmp_dir
-  if args[:set]
-    vals = OrigenAppGenerators::TEST_INPUTS[args[:set].to_i]
-    vals.pop # Throw away the test commands
-    str = vals.map { |i| i == :default ? "\n" : "#{i}\n" }.join('')
-    result = system "echo '#{str}' | rake test"
-  else
-    result = _execute_generator(:invoke)
-  end
-  exit 1 unless result
-end
-
-desc "Test run a specific generator: rake 'run[TestEngineering::GenericTestBlock]'"
-task :run, [:generator_class] do |_t, args|
-  _delete_tmp_dir
-  begin
-    klass = eval(args[:generator_class])
-  rescue
-    klass = eval("OrigenAppGenerators::#{args[:generator_class]}")
-  end
-  _execute_generator(klass)
-end
-
-desc 'Test that all generators build'
-task :regression do
-  OrigenAppGenerators::TEST_INPUTS.each do |inputs|
-    # Default test that are run for all app builds
-    commands = ['origen -v',
-                'origen lint',
-                'rake new_app_tests:load_target',
-                'origen web compile --no-serve'
-               ] + inputs.pop
-    if ENV['TRAVIS'] && ENV['CONTINUOUS_INTEGRATION']
-      prefix = 'bundle && bundle exec '
-    end
-    str = inputs.map { |i| i == :default ? "\n" : "#{i}\n" }.join('')
-    # Test the app can build
-    unless system "echo '#{str}' | rake test"
-      Origen.app.stats.report_fail
-      exit 1
-    end
-    # Copy the new app test rake tasks to the new app
-    t = File.expand_path('../new_app_tests.rake', Pathname.new(__FILE__).realpath)
-    FileUtils.cp t, 'tmp/lib/tasks'
-    # Test the app can boot
-    Bundler.with_clean_env do
-      Dir.chdir 'tmp' do
-        commands.each do |command|
-          Origen.log.info "Running command: #{command}"
-          unless system("#{prefix}#{command}")
-            Origen.app.stats.report_fail
-            exit 1
-          end
-          Origen.log.success "Command passed: #{command}"
-        end
-      end
-    end
-  end
-  Origen.app.stats.report_pass
-end
-
-def _execute_generator(klass)
-  # With the generator identified this now launches it in a standalone shell
-  # This is to emulate how it will run in real life and cause it to fail if there are
-  # any dependencies on running within an Origen app environment
-  boot = "#{File.expand_path(File.dirname(__FILE__))}/boot.rb"
-  origen_lib = "#{Origen.top}/lib"
-  origen_lib = '/proj/mem_c40tfs_testeng/r49409/origen/lib'
-  cmd = "#{boot} #{origen_lib} #{klass}"
-  cmd = "ruby #{cmd}" if Origen.running_on_windows?
-  # puts cmd
-  result = false
-  Bundler.with_clean_env do
-    result = system cmd
-  end
-  result
-end
-
-def _delete_tmp_dir
-  sh "rm -rf #{Origen.root}/tmp", verbose: false do |ok, _res|
-    # Sometimes vim can lock a dir if the file is being viewed, trying again will
-    # usually finish the job
-    unless ok
-      sh "rm -rf #{Origen.root}/tmp", verbose: false do |ok, _res|
-        unless ok
-          # I did my best!
-        end
-      end
-    end
-  end
-end
+# You can define any Rake tasks to support your application here (or in any file
+# ending in .rake in this directory).
+#
+# Rake (Ruby Make) is very useful for creating build scripts, see this short video
+# for a quick introduction:
+# http://railscasts.com/episodes/66-custom-rake-tasks

data/lib/tasks/new_app_tests.rake

@@ -1,5 +1,7 @@
+# This file has been added by origen_app_generators to test that the target can be
+# loaded within this application, it will not be included in your final application
+# builds once your generator has been released.
 namespace :new_app_tests do
-  desc 'Test that the app and default target can load'
   task :load_target do
     Origen.app.target.load!
   end

data/templates/app_generators/application/config/application.rb

@@ -80,7 +80,17 @@ class <%= @namespace %>Application < Origen::Application
   #    system command
   #  end
   #end
-
+<% if @validate_release_tests %>  
+  # Ensure that all tests pass before allowing a release to continue
+  def validate_release
+    if <%= Array(@validate_release_tests).map { |t| "!system('#{t}')" }.join(' || ') %>
+      puts "Sorry but you can't release with failing tests, please fix them and try again."
+      exit 1
+    else
+      puts "All tests passing, proceeding with release process!"
+    end
+  end
+<% else %>
   # Ensure that all tests pass before allowing a release to continue
   #def validate_release
   #  if !system("origen specs") || !system("origen examples")
@@ -90,6 +100,7 @@ class <%= @namespace %>Application < Origen::Application
   #    puts "All tests passing, proceeding with release process!"
   #  end
   #end
+<% end -%>
 
   # To enabled source-less pattern generation create a class (for example PatternDispatcher)
   # to generate the pattern. This should return false if the requested pattern has been

data/templates/app_generators/new/generator.rb

@@ -1,4 +1,4 @@
-module OrigenAppGenerators
+module <%= @namespace %>
   module <%= @domain_namespace %>
     # Generates a generic application shell
     class <%= @classname %> < <%= @parentclass %>
@@ -12,20 +12,33 @@ module OrigenAppGenerators
       def get_user_input
         # The methods to get the common user input that applies to all applications will
         # get called at the start automatically, you have a chance here to ask any additional
-        # questions that are specific to the type of application being generated
+        # questions that are specific to the type of application being generated.
+        # See the following links for some examples of how to ask questions:
+        # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/base.rb#L94
+        # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb#L44
       end
 
       def generate_files
         # Calling this will build all files, directories and symlinks contained in the
-        # hash returned by the filelist method
+        # hash returned by the filelist method below
         build_filelist 
       end
 
       def modify_files
-        # If you want to modify any of the generated files you can do so now, you have access
-        # to all of the Thor Action methods described here:
+        # Here you can add or remove things post-generation.
+        # Alternatively, you can copy any master file to the equivalent sub-directory of
+        # templates/app_generators/<%= @domain_namespace.underscore %>/<%= @classname.underscore %>
+        # and this will override the version in the master directory.
+        #
+        # However, post generation modification is recommended when possible since it means that your
+        # generated applications will automatically stay up to date with any improvements made to the
+        # master file.
+        # The downside is that creating a post-generation modification takes a bit more effort to create
+        # compared to simply copying and modifying the file manually.
+        # To help with creating modifications, you have access to all of the Thor Action methods described here:
         # http://www.rubydoc.info/github/wycats/thor/Thor/Actions
-        # See the enable method in lib/app_generators/new.rb for some examples of using these.
+        # See the enable method for an example of using these here:
+        # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/new.rb#L25
       end
 
       def conclude
@@ -36,38 +49,47 @@ module OrigenAppGenerators
       protected
 
       # Defines the filelist for the generator, the default list is inherited from the
-      # parent class (<%= @parentclass %>).
+      # parent class (<%= @namespace %>::<%= @parentclass %>).
+      # <% if @parentclass == 'Plugin' -%>  
+      # Since this is a plugin generator, the default list of files comprises the application list,
+      # which you can see here:
+      # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+      # And this is then modified by the base plugin generator which you can see here:
+      # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb
+      # Additionally, this application could have made further modifications to the default list
+      # within lib/<%= @namespace.underscore %>/plugin.rb
+<% else %>
+      # See here for the default list of files included in an application:
+      # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+      # Additionally, this application could have made further modifications to the default list
+      # within lib/<%= @namespace.underscore %>/application.rb
+<% end -%>
+      #
       # The filelist can contain references to generate files, directories or symlinks in the
       # new application.
       #
-      # Generally to make your generator more maintainable try and re-use as much as possible
-      # from the parent generator, this means that your generator will automatically stay up
-      # to date with the latest conventions
-      #
-      # The master templates live in templates/app_generators/<%= @parentclass.downcase %>, but
-      # DO NOT MODIFY THESE FILES DIRECTLY.
-      # Either add or remove things post-generation in the modify_files method or copy the
-      # master file to the equivalent sub-directory of templates/app_generators/<%= @domain_namespace.underscore %>/<%= @classname.underscore %>
-      # which will override the version in the master directory.
+      # To make your generator more maintainable, try and re-use as much as possible
+      # from the parent generator, this means that your generators will automatically stay up
+      # to date with the latest conventions.
       #
       # Additional files can be added or removed from the filelist as shown below.
       def filelist
         @filelist ||= begin
           list = super  # Always pick up the parent list
           # Example of how to remove a file from the parent list
-          #list.delete(:web_doc_layout)
+          # list.delete(:web_doc_layout)
           # Example of how to add a file, in this case the file will be compiled and copied to
           # the same location in the new app
-          #list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
+          # list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
           # Alternatively specifying a different destination, typically you would do this when
           # the final location is dynamic
-          #list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
+          # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
           # Example of how to create a directory
-          #list[:pattern_dir] = { dest: "pattern", type: :directory }
+          # list[:pattern_dir] = { dest: "pattern", type: :directory }
           # Example of how to create a symlink
-          #list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
-          #                          dest:   'target/default.rb', # Relative to destination_root
-          #                          type:   :symlink }
+          # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+          #                           dest:   'target/default.rb', # Relative to destination_root
+          #                           type:   :symlink }
           # Remember to return the final list
           list
         end

data/templates/app_generators/origen_infrastructure/app_generator_plugin/config/load_generators.rb

@@ -0,0 +1,7 @@
+# This file is used to hook the generators defined in this plugin into the
+# 'origen new' command, it must not be removed or modified
+
+require 'origen_app_generators'
+require "<%= @name %>"
+
+OrigenAppGenerators.add_generators(<%= @namespace %>::AVAILABLE)

data/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/application.rb

@@ -0,0 +1,48 @@
+module <%= @namespace %>
+  # This will be the parent class of all of your application generators, it provides a place
+  # to add anything that you want to be added to all of your applications
+  class Application < OrigenAppGenerators::Application
+    # Any methods added above the protected line will get automatically invoked
+    # at the start of *all* of your application generators.
+
+    protected
+
+    # You can add helper methods that you want to make available to all of your application
+    # generators here, these will not get called unless a child generator calls them.
+
+    # Here you can modify the default list of files that are included in all of your applications.
+    #
+    # See here for the default list of files:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new application.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generator, this means that your generator will automatically stay up
+    # to date with the latest conventions.
+    #
+    # Additional files can be added or removed from the filelist as shown below.
+    def filelist
+      @filelist ||= begin
+        list = super  # Always pick up the parent list
+        # Example of how to remove a file from the parent list
+        # list.delete(:web_doc_layout)
+        # Example of how to add a file, in this case the file will be compiled and copied to
+        # the same location in the new app
+        # list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
+        # Alternatively specifying a different destination, typically you would do this when
+        # the final location is dynamic
+        # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
+        # Example of how to create a directory
+        # list[:pattern_dir] = { dest: "pattern", type: :directory }
+        # Example of how to create a symlink
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                           dest:   'target/default.rb', # Relative to destination_root
+        #                           type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/module.rb

@@ -0,0 +1,27 @@
+require 'origen_app_generators'
+require '<%= @name %>/application'
+require '<%= @name %>/plugin'
+
+module <%= @namespace %>
+  # Define test sets of inputs to test your generators. The last item in each array is
+  # required and always indicates what action should be taken once the application has
+  # been built. nil means take no action, :default means to run a default set of test
+  # operations, and an array of Origen command strings gives you control of exactly
+  # what to run.
+  #
+  # These inputs can be executed individually by running 'origen app_gen:test -i INDEX',
+  # where INDEX is the index number of the set you want to execute from the TEST_INPUTS
+  # array.
+  #
+  # You can also execute all sets of test inputs by running: 'origen app_gen:test -r'
+  TEST_INPUTS = [
+  ] # END_OF_TEST_INPUTS Don't remove this comment, it is used by the app_gen:new command!
+
+  # As you add new generators to this app they will be entered here, this enables the
+  # mechanism to register them with the 'origen new' command.
+  # You should generally not modify this by hand, instead use the 'origen app_gen:new'
+  # command every time you want to create a new generator, and this will be filled in
+  # for you.
+  AVAILABLE = {
+  }
+end

data/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/plugin.rb

@@ -0,0 +1,58 @@
+module <%= @namespace %>
+  # This will be the parent class of all of your plugin generators, it provides a place
+  # to add anything that you want to be added to all of your plugins
+  class Plugin < OrigenAppGenerators::Plugin
+    def initialize(*args)
+      # This makes all of your plugins be configured for internal distribution, i.e. rather
+      # than via rubygems.org
+      @audience = :internal
+      super
+    end
+
+    # Any methods added above the protected line will get automatically invoked
+    # at the start of *all* of your plugin generators.
+
+    protected
+
+    # You can add helper methods that you want to make available to all of your plugin
+    # generators here, these will not get called unless a child generator calls them.
+
+    # Here you can modify the default list of files that are included in all of your plugins.
+    #
+    # Since this is a plugin genrator, the default list of files comprises the application list,
+    # which you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    # And this is then modified by the base plugin generator which you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new plugin.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generator, this means that your generators will automatically stay up
+    # to date with the latest conventions.
+    #
+    # Additional files can be added or removed from the filelist as shown below.
+    def filelist
+      @filelist ||= begin
+        list = super  # Always pick up the parent list
+        # Example of how to remove a file from the parent list
+        # list.delete(:web_doc_layout)
+        # Example of how to add a file, in this case the file will be compiled and copied to
+        # the same location in the new app
+        # list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
+        # Alternatively specifying a different destination, typically you would do this when
+        # the final location is dynamic
+        # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
+        # Example of how to create a directory
+        # list[:pattern_dir] = { dest: "pattern", type: :directory }
+        # Example of how to create a symlink
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                          dest:   'target/default.rb', # Relative to destination_root
+        #                          type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/templates/app_generators/plugin/Gemfile

@@ -3,8 +3,8 @@ source 'https://rubygems.org'
 source '<%= Origen.site_config.gem_server %>'
 <% end -%>
 
-# Only development dependencies (things your only plugin needs when running in its own workspace) should
-# be listed here in the Gemfile
+# Only development dependencies (things your plugin needs only when it is running in its own workspace)
+# should be listed here in the Gemfile
 <% if @audience == :external -%>
 # This gem provides integration with https://coveralls.io/ to monitor
 # your application's test coverage

data/templates/app_generators/plugin/gemspec.rb

@@ -31,7 +31,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "origen", ">= <%= @latest_origen_version %>"
 <% if @runtime_dependencies -%>  
   <% @runtime_dependencies.each do |dep| -%>
-  spec.add_runtime_dependency <%= dep.map{ |d| "\"#{d}\"" }.join(', ') %>
+spec.add_runtime_dependency <%= dep.map{ |d| "\"#{d}\"" }.join(', ') %>
+  <% end -%>
+<% end -%>
+<% if @post_runtime_dependency_comments -%>  
+  <% @post_runtime_dependency_comments.each do |line| -%>
+# <%= line %>
   <% end -%>
 <% end -%>
 end

data/templates/app_generators/test_engineering/stand_alone_application/Gemfile

@@ -11,4 +11,10 @@ gem 'origen_debuggers'
 
 gem 'origen_doc_helpers'
 
-gem 'byebug', '~>3.5'
+gem 'byebug'
+
+gem 'origen_updater'
+
+# Uncomment these if you want to use a visual debugger (e.g. Visual Studio Code) to debug your app
+#gem 'ruby-debug-ide'
+#gem 'debase'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_app_generators
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.22.0
 description: 
 email:
 - stephen.f.mcginty@gmail.com
@@ -31,10 +31,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/boot.rb
 - bin/fix_my_workspace
 - config/application.rb
 - config/boot.rb
 - config/commands.rb
+- config/shared_commands.rb
 - config/version.rb
 - lib/origen_app_generators.rb
 - lib/origen_app_generators/application.rb
@@ -42,12 +44,12 @@ files:
 - lib/origen_app_generators/empty_application.rb
 - lib/origen_app_generators/empty_plugin.rb
 - lib/origen_app_generators/new.rb
+- lib/origen_app_generators/origen_infrastructure/app_generator_plugin.rb
 - lib/origen_app_generators/plugin.rb
 - lib/origen_app_generators/sub_block_parser.rb
 - lib/origen_app_generators/test_engineering/stand_alone_application.rb
 - lib/origen_app_generators/test_engineering/test_block.rb
 - lib/tasks/app_generators.rake
-- lib/tasks/boot.rb
 - lib/tasks/new_app_tests.rake
 - templates/app_generators/application/.gitignore
 - templates/app_generators/application/.irbrc
@@ -76,6 +78,10 @@ files:
 - templates/app_generators/application/templates/web/release_notes.md.erb
 - templates/app_generators/new/generator.rb
 - templates/app_generators/new/info.md.erb
+- templates/app_generators/origen_infrastructure/app_generator_plugin/config/load_generators.rb
+- templates/app_generators/origen_infrastructure/app_generator_plugin/lib/application.rb
+- templates/app_generators/origen_infrastructure/app_generator_plugin/lib/module.rb
+- templates/app_generators/origen_infrastructure/app_generator_plugin/lib/plugin.rb
 - templates/app_generators/plugin/Gemfile
 - templates/app_generators/plugin/Rakefile
 - templates/app_generators/plugin/config/boot.rb
@@ -109,7 +115,7 @@ files:
 - templates/app_generators/test_engineering/test_block/target/default.rb
 homepage: http://origen-sdk.org/origen_app_generators
 licenses:
-- LGPL-3
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []