origen_app_generators 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33cb984e45e37d72975819a593e86344319d9740
-  data.tar.gz: 395d5c5f0168dc3440593a50205015977910755b
+  metadata.gz: 12f932a68b79d412af20be670cbc65b00a46a070
+  data.tar.gz: 1fbdec258c274fc187afabddf0541a3168db5650
 SHA512:
-  metadata.gz: baed87490e8e0137b4d9af0234dd4bc2b73f70432866e76a40edc920c757416faaf301425110c1a09fe378d127ed2d35608cb93526c1fd05bfc45b63bad36c52
-  data.tar.gz: 9647e1fa305fa8c0c117f19364f5b5c981ffe2ba4b1c1b1f069b218865d517235ada00de734359c5e16edf968aa28f5cc50d6614f18f3cb2560ae9ece772fb3f
+  metadata.gz: 76cb92b2edd4ee49d245e7a560aa98faaee5907c6e5b26dc7062b22e532a893ae5eb11ab8830616a55807dfdb34ada4706935b1b89df8d30df51d1ceab0ec4d2
+  data.tar.gz: f58c7cb74b8af6159e2c65cd672e37ad23f357b66b7de8a372b890898262ce8df93a4822d1c6bf68e29d45b4c7fc1d9fb6cb7de39e397a4c424da535033c92cf

data/config/commands.rb

@@ -18,20 +18,13 @@ aliases ={
 @command = aliases[@command] || @command
 
 ## Now branch to the specific task code
-#case @command
-#
-## Run the unit tests  
-#when "specs"
-#  ARGV.unshift "spec"
-#  require "rspec"
-#  # For some unidentified reason Rspec does not autorun on this version
-#  if RSpec::Core::Version::STRING && RSpec::Core::Version::STRING == "2.11.1"
-#    RSpec::Core::Runner.run ARGV
-#  else
-#    require "rspec/autorun"
-#  end
-#  exit 0 # This will never be hit on a fail, RSpec will automatically exit 1
-#
+case @command
+
+# Run the unit tests  
+when "specs"
+  require "rspec"
+  exit RSpec::Core::Runner.run(['spec'])
+
 ## Run the example-based (diff) tests
 #when "examples"  
 #  Origen.load_application
@@ -62,14 +55,9 @@ aliases ={
 ## You probably want to also add the command details to the help shown via
 ## origen -h, you can do this be assigning the required text to @application_commands
 ## before handing control back to Origen. Un-comment the example below to get started.
-#else
-#  @application_commands = <<-EOT
-# specs        Run the specs (tests), -c will enable coverage
-# examples     Run the examples (tests), -c will enable coverage
-#  EOT
-#
-#  # Uncomment the following and update the path with the file
-#  # that handles the commands that are shared from this plugin
-#  #require "#{Origen.app_root}/config/shared_commands"
-#
-#end 
+else
+  @application_commands = <<-EOT
+ specs        Run the specs (tests), -c will enable coverage
+  EOT
+
+end 

data/config/version.rb

@@ -1,7 +1,7 @@
 module OrigenAppGenerators
   MAJOR = 0
-  MINOR = 0
-  BUGFIX = 3
+  MINOR = 1
+  BUGFIX = 0
   DEV = nil
 
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/origen_app_generators.rb

@@ -6,16 +6,27 @@ require 'origen_app_generators/plugin'
 require 'origen_app_generators/generic_application'
 require 'origen_app_generators/generic_plugin'
 require 'origen_app_generators/new'
-require 'origen_app_generators/test_engineering/generic_test_block'
+require 'origen_app_generators/test_engineering/test_block'
+require 'origen_app_generators/test_engineering/stand_alone_application'
 
 module OrigenAppGenerators
   extend Origen::Utility::InputCapture
 
+  TEST_INPUTS = [
+    # Generic app
+    ['0', '0', :default, :default, []],
+    # Generic 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']]
+  ]
+
   # 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
   AVAILABLE = {
     'Test Engineering' => [
-      OrigenAppGenerators::TestEngineering::GenericTestBlock
+      OrigenAppGenerators::TestEngineering::TestBlock,
+      OrigenAppGenerators::TestEngineering::StandAloneApplication
     ]
   }
 
@@ -23,7 +34,7 @@ module OrigenAppGenerators
     puts
     puts 'CHOOSE AN ENGINEERING DOMAIN'
     puts
-    puts "Domain specific application templates are available for the following areas (enter '0' to build a generic one)"
+    puts "Domain-specific application templates are available for the following areas (enter '0' to build an empty generic one)"
     puts
     i = 0
     accept = [0]
@@ -39,11 +50,16 @@ module OrigenAppGenerators
       puts
       puts "WHAT TYPE OF APPLICATION DO YOU WANT TO BUILD? (if you don't know go with 'application')"
       puts
-      type = get_text(single: true, default: 'application', accept: %w(application plugin)).downcase.to_sym
+      puts '0 - Application'
+      puts '1 - Plugin'
+      puts
+      accept = [0, 1]
+      selection = get_text(single: true, accept: accept, default: 0).to_i
 
-      if type == :application
+      case selection
+      when 0
         OrigenAppGenerators::GenericApplication.start [path]
-      else
+      when 1
         OrigenAppGenerators::GenericPlugin.start [path]
       end
     else

data/lib/origen_app_generators/application.rb

@@ -27,8 +27,7 @@ module OrigenAppGenerators
       @filelist ||= {
         config_application: { source: 'config/application.rb' },
         config_version:     { source: 'config/version.rb' },
-        config_users:       { source: 'config/users.rb' },
-        config_environment: { source: 'config/environment.rb' },
+        config_boot:        { source: 'config/boot.rb' },
         config_commands:    { source: 'config/commands.rb' },
         doc_history:        { source: 'doc/history' },
         target_debug:       { source: 'target/debug.rb' },
@@ -43,19 +42,27 @@ module OrigenAppGenerators
         lib_tasks:          { source: 'lib/app.rake',
                               dest:   "lib/tasks/#{@name}.rake" },
         spec_helper:        { source: 'spec/spec_helper.rb' },
-        web_index:          { source: 'templates/web/index.md.erb' },
-        web_basic_layout:   { source: 'templates/web/layouts/_basic.html.erb' },
-        web_doc_layout:     { source: 'templates/web/layouts/_doc.html.erb' },
-        web_navbar:         { source: 'templates/web/partials/_navbar.html.erb' },
-        web_references:     { source: 'templates/web/references.md.erb' },
-        web_archive:        { source: 'templates/web/archive.md.erb' },
-        web_contact:        { source: 'templates/web/contact.md.erb' },
-        web_release_notes:  { source: 'templates/web/release_notes.md.erb' },
-        web_defintions:     { source: 'templates/web/docs/environment/definitions.md.erb' },
-        web_installation:   { source: 'templates/web/docs/environment/installation.md.erb' },
-        web_introduction:   { source: 'templates/web/docs/environment/introduction.md.erb' },
+        # web_index:          { source: 'templates/web/index.md.erb' },
+        # web_basic_layout:   { source: 'templates/web/layouts/_basic.html.erb' },
+        # web_doc_layout:     { source: 'templates/web/layouts/_doc.html.erb' },
+        # web_navbar:         { source: 'templates/web/partials/_navbar.html.erb' },
+        # web_references:     { source: 'templates/web/references.md.erb' },
+        # web_archive:        { source: 'templates/web/archive.md.erb' },
+        # web_contact:        { source: 'templates/web/contact.md.erb' },
+        # web_release_notes:  { source: 'templates/web/release_notes.md.erb' },
+        # web_defintions:     { source: 'templates/web/docs/environment/definitions.md.erb' },
+        # web_installation:   { source: 'templates/web/docs/environment/installation.md.erb' },
+        # web_introduction:   { source: 'templates/web/docs/environment/introduction.md.erb' },
         rakefile:           { source: 'Rakefile' },
-        gemfile:            { source: 'Gemfile' }
+        gemfile:            { source: 'Gemfile' },
+        gitignore:          { source: '.gitignore' },
+        irbrc:              { source: '.irbrc' },
+        rspec:              { source: '.rspec' },
+        # This sets the default mode of the new workspace to 'default'
+        session:            { source: 'origen_core_session',
+                              dest:   '.session/origen_core',
+                              copy:   true
+                            }
       }
     end
   end

data/lib/origen_app_generators/base.rb

@@ -36,6 +36,19 @@ module OrigenAppGenerators
 
     protected
 
+    def debugger
+      require 'byebug'
+      byebug # rubocop:disable Lint/Debugger
+    end
+
+    def plugin?
+      type == :plugin
+    end
+
+    def application?
+      !plugin?
+    end
+
     def self.title
       desc.sub(/^An? /, '').titleize
     end
@@ -96,6 +109,7 @@ module OrigenAppGenerators
           if file[:copy] || dest =~ /.erb$/
             copy_file(file[:source], dest)
           else
+            @options = file[:options] || {}
             template(file[:source], dest)
           end
         end
@@ -118,8 +132,9 @@ module OrigenAppGenerators
       puts "SELECT YOUR #{type.to_s.upcase}'S NAMESPACE"
       puts
       puts "All #{type} code needs to reside in a unique namespace, this prevents naming collisions with 3rd party plugins."
-      puts 'By Ruby conventions this must start with a capital letter and should ideally be CamelCased and not use underscores'
-      puts 'Some examples:: C40TFSNVMTester, CAPIOrigen, LS2080, ApacheOrigen'
+      puts 'By Ruby conventions, this must start with a capital letter and should ideally be CamelCased and not use underscores.'
+      # puts 'Some examples:: C40TFSNVMTester, CAPIOrigen, LS2080, ApacheOrigen'
+      [@namespace_advice].each { |l| puts l } if @namespace_advice
       puts
       if !proposal && @name
         proposal = @name.to_s.camelize
@@ -175,7 +190,7 @@ module OrigenAppGenerators
       puts "WHAT DO YOU WANT TO CALL YOUR NEW #{type.to_s.upcase}?"
       puts
       puts "This should be lowercased and underscored and will be used to uniquely identify your #{type} within the Origen ecosystem."
-      puts 'Some examples: c40tfs_nvm_tester, capi_origen, ls2080, apache_origen'
+      [@name_advice].each { |l| puts l } if @name_advice
       puts
       valid = false
       until valid

data/lib/origen_app_generators/plugin.rb

@@ -4,7 +4,8 @@ module OrigenAppGenerators
     def get_common_user_input
       get_name_and_namespace
       get_summary
-      get_revision_control
+      get_audience
+      # get_revision_control
     end
 
     protected
@@ -18,9 +19,11 @@ module OrigenAppGenerators
         list.delete(:web_defintions)
         list.delete(:web_installation)
         list.delete(:web_introduction)
-        list[:config_development] = { source: 'config/development.rb' }
         list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
         list[:templates_shared] = { dest: 'templates/shared', type: :directory }
+        if @audience == :external
+          list[:travis] = { source: '.travis.yml' }
+        end
         list
       end
     end
@@ -32,6 +35,18 @@ module OrigenAppGenerators
       @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...'
+      puts
+      confirm_external = get_text(confirm: :return_boolean, default: 'no')
+      @audience = :external if confirm_external
+    end
+
     def type
       :plugin
     end

data/lib/origen_app_generators/sub_block_parser.rb

@@ -0,0 +1,81 @@
+module OrigenAppGenerators
+  require 'strscan'
+  # Responsible for parsing something like this:
+  #
+  #   "ram, osc, pll, atd(2), comms[ram(2), osc](3)"
+  #
+  # into this:
+  #
+  #   {
+  #     "RAM"=>{}, "Osc"=>{}, "PLL"=>{}, "ATD"=> {:instances=>2},
+  #     "Comms"=>{:instances=>3, :children=>{"RAM"=>{:instances=>2}, "Osc"=>{}}}
+  #   }
+  #
+  class SubBlockParser
+    def parse(str)
+      r = {}
+      split(str).each do |tag|
+        tag, i = extract_instances(tag)
+        name, children = extract_children(tag)
+        name = camelize(name)
+        r[name] = {}
+        r[name][:instances] = i if i
+        r[name][:children] = children if children
+      end
+      r
+    end
+
+    private
+
+    # Splits the given string by comma, but understands that nested
+    # commas should not be split on
+    def split(str)
+      r = []
+      str = StringScanner.new(str)
+      r << next_tag(str) until str.eos?
+      r
+    end
+
+    def next_tag(str)
+      v = str.scan_until(/,|\[|$/)
+      if v[-1] == ','
+        v.chop.strip
+      elsif v[-1] == '['
+        open = 1
+        while open > 0
+          v += str.scan_until(/\[|\]/)
+          if v[-1] == '['
+            open += 1
+          else
+            open -= 1
+          end
+        end
+        v += next_tag(str)
+      # End of line
+      else
+        v.strip
+      end
+    end
+
+    def extract_children(tag)
+      # http://rubular.com/r/plGILY2e2U
+      if tag.strip =~ /([^\[]*)\[(.*)\]/
+        [Regexp.last_match(1), parse(Regexp.last_match(2))]
+      else
+        [tag.strip, nil]
+      end
+    end
+
+    def extract_instances(tag)
+      if tag.strip =~ /(.*)\((\d+)\)$/
+        [Regexp.last_match(1), Regexp.last_match(2).to_i]
+      else
+        [tag.strip, nil]
+      end
+    end
+
+    def camelize(val)
+      val.strip.gsub(/\s+/, '_').camelize
+    end
+  end
+end

data/lib/origen_app_generators/test_engineering/stand_alone_application.rb

@@ -0,0 +1,232 @@
+module OrigenAppGenerators
+  module TestEngineering
+    require 'origen_app_generators/sub_block_parser'
+    # Generates a generic application shell
+    class StandAloneApplication < Application
+      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
+        get_top_level_names
+        get_sub_block_names
+      end
+
+      def generate_files
+        # 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}"
+      end
+
+      protected
+
+      def sub_block_parser
+        @sub_block_parser ||= SubBlockParser.new
+      end
+
+      def get_top_level_names
+        puts
+        puts 'NAME YOUR TOP-LEVEL DEVICE(S)'
+        puts
+        puts 'What do you want to call the top-level class that represents your device?'
+        puts 'By default it will be called TopLevel, but if you want this application to support multiple devices you should'
+        puts 'give them unique names.'
+        puts 'Separate multiple names with a comma:    Falcon, Eagle, Vulture'
+        puts
+
+        valid = false
+        until valid
+          @top_level_names = get_text(single: true, default: 'TopLevel').strip.split(',').map do |name|
+            name.strip.gsub(/\s+/, '_').camelize
+          end
+          unless @top_level_names.empty?
+            # Should we check anything here?
+            valid = true
+          end
+        end
+        @top_level_names
+      end
+
+      def get_sub_block_names
+        puts
+        puts 'DEFINE YOUR SUB-BLOCKS'
+        puts
+        puts 'What sub-blocks does this device contain?'
+        puts 'You can leave this blank, but entering some details of the sub-blocks you will want to involve in your tests'
+        puts 'will save you some manual setup of the associated models and controllers.'
+        puts 'You can specify layers of hierarchy and multiple instantiations, here are some examples:'
+        puts
+        puts '  A RAM, OSC, PLL and 2 ATDs at the top-level:    ram, osc, pll, atd(2)'
+        puts '  With 3 COMMS blocks with embedded components:   ram, osc, pll, atd(2), comms[ram(2), osc](3)'
+        if @top_level_names.size > 1
+          puts
+          puts 'If you want different modules for each of your top-level devices you can do:'
+          puts
+          puts "  #{@top_level_names[0]}[ram, atd(2)], #{@top_level_names[1]}[ram(2), atd(4)]"
+        end
+        puts
+
+        valid = false
+        until valid
+          input = get_text(single: true).strip
+          if input.empty?
+            @sub_blocks_lookup = {}
+            valid = true
+          else
+            begin
+              @sub_blocks_lookup = sub_block_parser.parse(input)
+              valid = true
+            rescue
+              valid = false
+            end
+          end
+        end
+        @sub_blocks_lookup
+      end
+
+      # Returns a hash that looks like:
+      #
+      #   {"Falcon"=>{"RAM"=>{}, "ATD"=>{:instances=>2}}, "Eagle"=>{"RAM"=>{:instances=>2}, "ATD"=>{:instances=>4}}}
+      def top_level_sub_blocks
+        blocks = {}
+        # Make sure that each top-level object has a sub blocks assignment
+        if @top_level_names.any? { |n| @sub_blocks_lookup[n] }
+          @top_level_names.each do |name|
+            if @sub_blocks_lookup[name]
+              blocks[name] = @sub_blocks_lookup[name][:children] || {}
+            else
+              blocks[name] = {}
+            end
+          end
+        # Duplicate the given sub blocks to all top-level objects if none have been specified
+        else
+          @top_level_names.each do |name|
+            blocks[name] = @sub_blocks_lookup
+          end
+        end
+        blocks
+      end
+
+      # Returns a hash with all sub-blocks at the top-level, e.g.:
+      #
+      #   {"RAM"=>{}, "ATD"=>{}, "Comms"=>{"RAM"=>{:instances=>2}, "Osc"=>{}}, "Osc"=>{}}
+      def sub_blocks
+        blocks = {}
+        top_level_sub_blocks.each do |top, attrs|
+          extract_sub_blocks(attrs) do |name, attrs|
+            if blocks[name]
+              if blocks[name] != (attrs[:children] || {})
+                Origen.log.warning "The app builder does not currently support different sub-block definitions for block #{name}"
+                Origen.log.warning 'Only the first defintion has been built'
+              end
+            else
+              blocks[name] = attrs[:children] || {}
+            end
+          end
+        end
+        blocks
+      end
+
+      def extract_sub_blocks(blocks, &block)
+        blocks.each do |name, attrs|
+          yield name, attrs
+          extract_sub_blocks(attrs[:children], &block) if attrs[:children]
+        end
+      end
+
+      # Defines the filelist for the generator, the default list is inherited from the
+      # parent class (Application).
+      # 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/application, 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/generic_stand_alone_application
+      # 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(:lib_top_level)
+          list.delete(:target_debug)
+          list.delete(:target_production)
+          list.delete(:target_default)
+          # 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
+          @top_level_names.each_with_index do |name, i|
+            list["top_level_model_#{i}"] = { source:  'lib/top_level.rb',
+                                             dest:    "lib/#{@name}/#{name.underscore}.rb",
+                                             options: { name: name, sub_blocks: top_level_sub_blocks[name] }
+                                           }
+
+            list["top_level_controller_#{i}"] = { source:  'lib/top_level_controller.rb',
+                                                  dest:    "lib/#{@name}/#{name.underscore}_controller.rb",
+                                                  options: { name: name }
+                                                }
+
+            list["target_#{name}"] = { source:  'target/top_level.rb',
+                                       dest:    "target/#{name.underscore}.rb",
+                                       options: { name: name }
+                                     }
+            if i == 0
+              list[:target_default] =  { source: "#{name.underscore}.rb", # Relative to the file being linked to
+                                         dest:   'target/default.rb',     # Relative to destination_root
+                                         type:   :symlink }
+            end
+          end
+
+          sub_blocks.each do |name, blocks|
+            list["ip_block_#{name}"] = { source:  'lib/ip_block.rb',
+                                         dest:    "lib/#{@name}/#{name.underscore}.rb",
+                                         options: { name: name, sub_blocks: blocks }
+                                       }
+
+            list["ip_block_controller_#{name}"] = { source: 'lib/ip_block_controller.rb',
+                                                    dest:   "lib/#{@name}/#{name.underscore}_controller.rb" }
+          end
+
+          list[:environment_j750] = { source: 'environment/j750.rb' }
+          list[:environment_uflex] = { source: 'environment/uflex.rb' }
+          list[:environment_v93k] = { source: 'environment/v93k.rb' }
+          list[:environment_jlink] = { source: 'environment/jlink.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: 'j750.rb',          # Relative to the file being linked to
+                                         dest:   'environment/default.rb', # Relative to destination_root
+                                         type:   :symlink }
+          list[:pattern_example] = { source: 'pattern/example.rb' }
+          # Remember to return the final list
+          list
+        end
+      end
+    end
+  end
+end