origen 0.34.3 → 0.52.0

data/origen_app_generators/lib/origen_app_generators/new_app_tests.rb

@@ -0,0 +1,4 @@
+# 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.
+Origen.app.target.load!

data/origen_app_generators/lib/origen_app_generators/origen_infrastructure/app_generator_plugin.rb

@@ -0,0 +1,107 @@
+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(:templates_shared)
+          # 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_base] = { source: 'app/lib/base.rb', dest: "app/lib/#{@name}/base.rb" }
+          list[:lib_plugin] = { source: 'app/lib/plugin.rb', dest: "app/lib/#{@name}/plugin.rb" }
+          list[:lib_application] = { source: 'app/lib/application.rb', dest: "app/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[:templates_app] = { dest: 'app/templates/app_generators/application', type: :directory }
+          list[:templates_plugin] = { dest: 'app/templates/app_generators/plugin', type: :directory }
+          list[:templates_base] = { dest: 'app/templates/app_generators/base', type: :directory }
+          # By default, directories created in this way will contain a .keep file, to inhibit this:
+          # list[:pattern_dir] = { dest: "pattern", type: :directory, nokeep: true }
+          # 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/origen_app_generators/lib/origen_app_generators/plugin.rb

@@ -0,0 +1,55 @@
+module OrigenAppGenerators
+  # The base generator class that should be used by all plugin generators
+  class Plugin < Application
+    def get_additional_user_input
+      get_summary
+      get_audience unless @audience
+    end
+
+    protected
+
+    # See Application#filelist for more details
+    def filelist
+      @filelist ||= begin
+        list = super
+        list.delete(:web_doc_layout)
+        list.delete(:web_references)
+        list.delete(:web_defintions)
+        list.delete(:web_installation)
+        list.delete(:web_introduction)
+        list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
+        list[:templates_shared] = { dest: 'app/templates/shared', type: :directory }
+        if @audience == :external
+          list[:travis] = { source: '.travis.yml' }
+          list[:web_navbar] = { source: 'app/templates/web/partials/_navbar_external.html.erb', dest: 'app/templates/web/partials/_navbar.html.erb' }
+        else
+          list[:web_navbar] = { source: 'app/templates/web/partials/_navbar_internal.html.erb', dest: 'app/templates/web/partials/_navbar.html.erb' }
+        end
+        list
+      end
+    end
+
+    def get_summary
+      puts
+      puts 'DESCRIBE YOUR NEW PLUGIN IN A FEW WORDS'
+      puts
+      @summary = get_text(single: true)
+    end
+
+    # Prompts the user to say whether the new plugin is intended for an internal
+    # or external audience (meaning it will published to rubygems.org)
+    def get_audience(proposal = nil)
+      puts
+      puts 'IS THIS PLUGIN GOING TO BE RELEASED TO AN EXTERNAL AUDIENCE?'
+      puts
+      puts 'By answering yes, this plugin will be pushed to rubygems.org when it is released and it will be available outside of your company.'
+      puts
+      confirm_external = get_text(confirm: :return_boolean, default: 'no')
+      @audience = :external if confirm_external
+    end
+
+    def type
+      :plugin
+    end
+  end
+end

data/origen_app_generators/lib/origen_app_generators/test_engineering/common.rb

@@ -0,0 +1,29 @@
+module OrigenAppGenerators
+  module TestEngineering
+    module Common
+      def common_filelist(list)
+        # Example of how to remove a file from the parent list
+        # list.delete(:target_debug)
+        # 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[:environment_v93k] = { source: 'environment/v93k.rb' }
+        list[:environment_j750] = { source: 'environment/j750.rb' }
+        list[:environment_uflex] = { source: 'environment/uflex.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[:environment_default] = { source: 'uflex.rb',           # Relative to the file being linked to
+                                       dest:   'environment/default.rb', # Relative to destination_root
+                                       type:   :symlink }
+        # Test engineering source directories
+        list[:patterns_dir] = { dest: 'app/patterns', type: :directory }
+        list[:flows_dir]    = { dest: 'app/flows', type: :directory }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/origen_app_generators/lib/origen_app_generators/test_engineering/stand_alone_application.rb

@@ -0,0 +1,64 @@
+module OrigenAppGenerators
+  module TestEngineering
+    # Generates a generic application shell
+    class StandAloneApplication < Application
+      include Common
+
+      desc 'A stand alone test engineering application'
+
+      # 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
+        @development_dependencies = [
+          ['origen_testers']
+        ]
+        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}"
+      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/test_engineering/mpg_test_block
+      # 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 = common_filelist(super)  # Always pick up the parent list
+          list
+        end
+      end
+    end
+  end
+end

data/origen_app_generators/lib/origen_app_generators/test_engineering/test_block.rb

@@ -0,0 +1,61 @@
+module OrigenAppGenerators
+  module TestEngineering
+    # Generates a generic plugin shell
+    class TestBlock < Plugin
+      include Common
+
+      desc 'An IP test module intended to plugin into a top-level (SoC) application'
+
+      def initialize(*args)
+        @audience = :internal
+        super
+      end
+
+      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_testers', '>= 0.6.1']
+        ]
+        build_filelist
+      end
+
+      def final_modifications
+        prepend_to_file "app/lib/#{@name}.rb", "require 'origen_testers'\n"
+      end
+
+      def conclude
+        puts "New test module created at: #{destination_root}"
+      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/test_engineering/mpg_test_block
+      # 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 = common_filelist(super)  # Always pick up the parent list
+          list
+        end
+      end
+    end
+  end
+end

data/origen_app_generators/origen_app_generators.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+# stub: origen_app_generators 2.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "origen_app_generators".freeze
+  s.version = "2.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.8.11".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Stephen McGinty".freeze]
+  s.date = "2019-06-10"
+  s.email = ["stephen.f.mcginty@gmail.com".freeze]
+  s.files = ["bin/boot.rb".freeze, "config/application.rb".freeze, "config/boot.rb".freeze, "config/commands.rb".freeze, "config/shared_commands.rb".freeze, "config/version.rb".freeze, "lib/origen_app_generators.rb".freeze, "lib/origen_app_generators/application.rb".freeze, "lib/origen_app_generators/base.rb".freeze, "lib/origen_app_generators/empty_application.rb".freeze, "lib/origen_app_generators/empty_plugin.rb".freeze, "lib/origen_app_generators/new.rb".freeze, "lib/origen_app_generators/new_app_tests.rb".freeze, "lib/origen_app_generators/origen_infrastructure/app_generator_plugin.rb".freeze, "lib/origen_app_generators/plugin.rb".freeze, "lib/origen_app_generators/test_engineering/common.rb".freeze, "lib/origen_app_generators/test_engineering/stand_alone_application.rb".freeze, "lib/origen_app_generators/test_engineering/test_block.rb".freeze, "templates/app_generators".freeze, "templates/app_generators/application".freeze, "templates/app_generators/application/.gitignore".freeze, "templates/app_generators/application/.irbrc".freeze, "templates/app_generators/application/.rspec".freeze, "templates/app_generators/application/.travis.yml".freeze, "templates/app_generators/application/Gemfile".freeze, "templates/app_generators/application/Rakefile".freeze, "templates/app_generators/application/app".freeze, "templates/app_generators/application/app/blocks".freeze, "templates/app_generators/application/app/blocks/top_level.rb".freeze, "templates/app_generators/application/app/lib".freeze, "templates/app_generators/application/app/lib/module.rb".freeze, "templates/app_generators/application/app/templates".freeze, "templates/app_generators/application/app/templates/web".freeze, "templates/app_generators/application/app/templates/web/index.md.erb".freeze, "templates/app_generators/application/app/templates/web/layouts".freeze, "templates/app_generators/application/app/templates/web/layouts/_basic.html.erb".freeze, "templates/app_generators/application/app/templates/web/partials".freeze, "templates/app_generators/application/app/templates/web/partials/_navbar.html.erb".freeze, "templates/app_generators/application/app/templates/web/release_notes.md.erb".freeze, "templates/app_generators/application/config".freeze, "templates/app_generators/application/config/application.rb".freeze, "templates/app_generators/application/config/boot.rb".freeze, "templates/app_generators/application/config/commands.rb".freeze, "templates/app_generators/application/config/maillist_dev.txt".freeze, "templates/app_generators/application/config/maillist_prod.txt".freeze, "templates/app_generators/application/config/version.rb".freeze, "templates/app_generators/application/doc".freeze, "templates/app_generators/application/doc/history".freeze, "templates/app_generators/application/dot_keep".freeze, "templates/app_generators/application/origen_core_session".freeze, "templates/app_generators/application/spec".freeze, "templates/app_generators/application/spec/spec_helper.rb".freeze, "templates/app_generators/application/target".freeze, "templates/app_generators/application/target/debug.rb".freeze, "templates/app_generators/application/target/default.rb".freeze, "templates/app_generators/application/target/production.rb".freeze, "templates/app_generators/new".freeze, "templates/app_generators/new/generator.rb".freeze, "templates/app_generators/new/info.md.erb".freeze, "templates/app_generators/origen_infrastructure".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/application.rb".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/base.rb".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/module.rb".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/plugin.rb".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/config".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/config/load_generators.rb".freeze, "templates/app_generators/plugin".freeze, "templates/app_generators/plugin/Gemfile".freeze, "templates/app_generators/plugin/Rakefile".freeze, "templates/app_generators/plugin/app".freeze, "templates/app_generators/plugin/app/templates".freeze, "templates/app_generators/plugin/app/templates/web".freeze, "templates/app_generators/plugin/app/templates/web/index.md.erb".freeze, "templates/app_generators/plugin/app/templates/web/partials".freeze, "templates/app_generators/plugin/app/templates/web/partials/_navbar_external.html.erb".freeze, "templates/app_generators/plugin/app/templates/web/partials/_navbar_internal.html.erb".freeze, "templates/app_generators/plugin/config".freeze, "templates/app_generators/plugin/config/boot.rb".freeze, "templates/app_generators/plugin/gemspec.rb".freeze, "templates/app_generators/test_engineering".freeze, "templates/app_generators/test_engineering/environment".freeze, "templates/app_generators/test_engineering/environment/j750.rb".freeze, "templates/app_generators/test_engineering/environment/uflex.rb".freeze, "templates/app_generators/test_engineering/environment/v93k.rb".freeze, "templates/app_generators/test_engineering/stand_alone_application".freeze, "templates/app_generators/test_engineering/stand_alone_application/.keep".freeze, "templates/app_generators/test_engineering/test_block".freeze, "templates/app_generators/test_engineering/test_block/.keep".freeze]
+  s.homepage = "http://origen-sdk.org/origen_app_generators".freeze
+  s.licenses = ["MIT".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.3".freeze)
+  s.rubygems_version = "2.7.7".freeze
+  s.summary = "Origen application generators".freeze
+
+  s.installed_by_version = "2.7.7" if s.respond_to? :installed_by_version
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<origen>.freeze, [">= 0.40.2"])
+    else
+      s.add_dependency(%q<origen>.freeze, [">= 0.40.2"])
+    end
+  else
+    s.add_dependency(%q<origen>.freeze, [">= 0.40.2"])
+  end
+end

data/origen_app_generators/target/debug.rb

@@ -0,0 +1,8 @@
+# Production mode will require that there are no modified files in the workspace
+# and any other conditions that you add to your application.
+# Normally production targets define the target and then debug targets
+# are setup to load the production target before switching Origen to debug
+# mode as shown below.
+load "#{Origen.root}/target/production.rb"
+
+Origen.mode = :debug

data/origen_app_generators/target/default.rb

@@ -0,0 +1,8 @@
+# Production mode will require that there are no modified files in the workspace
+# and any other conditions that you add to your application.
+# Normally production targets define the target and then debug targets
+# are setup to load the production target before switching Origen to debug
+# mode as shown below.
+load "#{Origen.root}/target/production.rb"
+
+Origen.mode = :debug

data/origen_app_generators/templates/app_generators/application/.gitignore

@@ -0,0 +1,37 @@
+# Misc
+.irb_history
+.byebug_history
+
+# Editor cruft
+*.swp
+*.swo
+*~
+
+# Origen local files
+/.bundle
+/target/.default
+/environment/.default
+/release_note.txt
+/pkg
+/lbin
+/.bin
+/list/referenced.list
+/tags
+/.ref
+/.ws
+/.lsf
+/.db
+/log
+/output
+/web
+/coverage
+/.ref
+/.yardoc
+/.collection
+/.bin
+/.session
+/tmp
+
+# Cruft from other revision control systems
+.SYNC
+.svn

data/origen_app_generators/templates/app_generators/application/.irbrc

@@ -0,0 +1,9 @@
+$VERBOSE=nil
+require 'pp'
+require 'rubygems'
+require 'irb/completion'
+require 'irb/ext/save-history'
+
+IRB.conf[:SAVE_HISTORY] = 100
+IRB.conf[:AUTO_INDENT] = true
+IRB.conf[:IRB_NAME] = "origen"

data/origen_app_generators/templates/app_generators/application/.rspec

@@ -0,0 +1 @@
+--color -f doc

data/origen_app_generators/templates/app_generators/application/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.2
+script:
+  - bundle exec origen -v
+  - bundle exec origen specs
+  - bundle exec origen examples
+  - bundle exec origen web compile --no-serve
+env:
+  - ORIGEN_GEM_USE_FROM_SYSTEM=false ORIGEN_GEM_MANAGE_BUNDLER=false