origen 0.28.2 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b668d7712bef8be358291fe9bec47914b1738b43
-  data.tar.gz: f24c2df62d2f22ec88a6e9d417205129e5923ce4
+  metadata.gz: 8d5351ecf83d751f998bd4d0a533dd7bb741a08a
+  data.tar.gz: ea50032d8fbcf618062720ee47e40b8d0416cf0f
 SHA512:
-  metadata.gz: e0eafb6914409f6a5ebdf07c03e769caf9457858570050d89ff4af0e4cd0672d5153802d31d448eb00c18b89dce97ef66908ef34972fec196f32c5f94dd4ba6a
-  data.tar.gz: e4616d302bd38753d3abd11feabc11a5e21cdc8bfe32f42415ec859eb094df3c93a5ff7412f42acdd11010e80f179bda5edec7fc145fa587fd1c52e5f3fc0c50
+  metadata.gz: 117326d05b4e9c7a7adc06d6ca8c16025eb31bae81db228922c965358e5898e6cd039f9fa8d6d8e38f61c63450850c60a1e408e87de86e3235847700d42ed761
+  data.tar.gz: 66b8a64e922594ada9b81c7369cbe8a468033aa6f4ac98452ed05716a346686229ff49b9ef55896378825c64a6614d834b7d2b7b1274c0cdc5e67b8fac500e45

data/bin/origen

@@ -43,6 +43,7 @@ else
   end
 end
 
+# If running inside an application workspace
 if origen_root
   # Force everyone to have a consistent way of installing gems with bundler
   ENV['BUNDLE_GEMFILE'] = File.join(origen_root, 'Gemfile')
@@ -58,6 +59,8 @@ if origen_root
   end
   
   boot_app = true
+
+# If running outside an application and a user or central tool Origen bundle is to be used
 elsif Origen.site_config.gem_manage_bundler && (Origen.site_config.user_install_enable || Origen.site_config.tool_repo_install_dir)
   # Force everyone to have a consistent way of installing gems with bundler.
   # In this case, we aren't running from an Origen application, so build everything at Origen.home instead
@@ -91,8 +94,17 @@ elsif Origen.site_config.gem_manage_bundler && (Origen.site_config.user_install_
   ENV['BUNDLE_GEMFILE'] = gemfile
   ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
   ENV['BUNDLE_BIN'] = File.join(origen_root, 'lbin')
-  
-  boot_app = false
+
+  origen_exec = File.join(ENV['BUNDLE_BIN'], 'origen')
+
+  # If the user/tool bundle already exists but we have not been invoked through that, abort this thread
+  # and re-launch under the required bundler environment
+  if File.exist?(origen_exec) && !ENV['BUNDLE_BIN_PATH'] && File.exist?(ENV['BUNDLE_PATH'])
+    exec Gem.ruby, origen_exec, *ARGV
+    exit 0
+  else
+    boot_app = false
+  end
 end
 
 if origen_root && File.exist?(ENV['BUNDLE_GEMFILE']) && Origen.site_config.gem_manage_bundler && (boot_app || Origen.site_config.user_install_enable || Origen.site_config.tool_repo_install_dir)

data/config/version.rb

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

data/lib/origen.rb

@@ -65,6 +65,8 @@ unless defined? RGen::ORIGENTRANSITION
     autoload :Tests,             'origen/tests'
     autoload :PowerDomains,      'origen/power_domains'
     autoload :Clocks,            'origen/clocks'
+    autoload :Value,             'origen/value'
+    autoload :OrgFile,           'origen/org_file'
 
     attr_reader :switch_user
 
@@ -79,10 +81,23 @@ unless defined? RGen::ORIGENTRANSITION
     class GitError < OrigenError; status_code(11); end
     class DesignSyncError < OrigenError; status_code(12); end
     class RevisionControlUninitializedError < OrigenError; status_code(13); end
+    class SyntaxError < OrigenError; status_code(14); end
 
     class << self
       include Origen::Utility::TimeAndDate
 
+      # Uniformly justifies the given help command line for display in a command line help output
+      def clean_help_line(str)
+        if str =~ /^\s\s\s\s\s\s\s*(.*)/
+          (' ' * 20) + Regexp.last_match(1)
+        # http://rubular.com/r/MKmU4xZgO2
+        elsif str =~ /^\s*([^\s]+)\s+*(.*)/
+          ' ' + Regexp.last_match(1).ljust(19) + Regexp.last_match(2)
+        else
+          str
+        end
+      end
+
       def enable_profiling
         @profiling = true
       end
@@ -272,17 +287,19 @@ unless defined? RGen::ORIGENTRANSITION
 
       # Returns true if Origen is running in an application workspace
       def in_app_workspace?
-        path = Pathname.new(Dir.pwd)
-        until path.root? || File.exist?(File.join(path, APP_CONFIG))
-          path = path.parent
+        @in_app_workspace ||= begin
+          path = Pathname.new(Dir.pwd)
+          until path.root? || File.exist?(File.join(path, APP_CONFIG))
+            path = path.parent
+          end
+          !path.root?
         end
-        !path.root?
       end
 
       # Shortcut method to find if Origen was invoked from within an application or from
       # the global Origen install. This is just the opposite of in_app_workspace?
       def running_globally?
-        !in_app_workspace?
+        @running_globally ||= !in_app_workspace?
       end
       alias_method :invoked_globally?, :running_globally?
 
@@ -299,7 +316,10 @@ unless defined? RGen::ORIGENTRANSITION
                 path = path.parent
               end
               if path.root?
-                path = top
+                @running_globally = true
+                path = Pathname.new($_origen_invocation_pwd || Dir.pwd)
+              else
+                @in_app_workspace = true
               end
               path
             end
@@ -451,47 +471,54 @@ unless defined? RGen::ORIGENTRANSITION
       # automatically the first time the application is referenced via Origen.app
       def load_application(options = {})
         @application ||= begin
-          # Make sure the top-level root is always in the load path, it seems that some existing
-          # plugins do some strange things to require stuff from the top-level app and rely on this
-          path = File.join(root, 'lib')
-          $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
-          # This flag is set so that when a thread starts with no app it remains with no app. This
-          # was an issue when building a new app with the fetch command and when the thread did a
-          # chdir to the new app directory (to fetch it) Origen.log would try to load the partial app.
-          @running_outside_an_app = true unless in_app_workspace?
-          return nil if @running_outside_an_app
-          # Load the app's plugins and other gem requirements
-          if File.exist?(File.join(root, 'Gemfile')) && !@with_boot_environment
-            # Don't understand the rules here, belt and braces approach for now to make
-            # sure that all Origen plugins are auto-required (otherwise Origen won't know
-            # about them to plug them into the application)
-            Bundler.require
-            Bundler.require(:development)
-            Bundler.require(:runtime)
-            Bundler.require(:default)
-          end
-          @plugins_loaded = true
-          # Now load the app
-          @loading_top_level = true
-          require File.join(root, APP_CONFIG)
-          @application = _applications_lookup[:root][root.to_s]
-          @loading_top_level = false
-          if @with_boot_environment
-            @application.plugins.disable_current
+          # If running globally (outside of an app workspace), instantiate a bare bones app to help
+          # many of Origen's features that expect an app to be present.
+          if running_globally?
+            @plugins_loaded = true
+            # Now load the app
+            @loading_top_level = true
+            require 'origen/global_app'
+            @application = _applications_lookup[:root][root.to_s]
+            @loading_top_level = false
+            @application_loaded = true
+            @application
           else
-            Origen.remote_manager.require!
+            # Make sure the top-level root is always in the load path, it seems that some existing
+            # plugins do some strange things to require stuff from the top-level app and rely on this
+            path = File.join(root, 'lib')
+            $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+            if File.exist?(File.join(root, 'Gemfile')) && !@with_boot_environment
+              # Don't understand the rules here, belt and braces approach for now to make
+              # sure that all Origen plugins are auto-required (otherwise Origen won't know
+              # about them to plug them into the application)
+              Bundler.require
+              Bundler.require(:development)
+              Bundler.require(:runtime)
+              Bundler.require(:default)
+            end
+            @plugins_loaded = true
+            # Now load the app
+            @loading_top_level = true
+            require File.join(root, APP_CONFIG)
+            @application = _applications_lookup[:root][root.to_s]
+            @loading_top_level = false
+            if @with_boot_environment
+              @application.plugins.disable_current
+            else
+              Origen.remote_manager.require!
+            end
+            boot = File.join(root, 'config', 'boot.rb')
+            require boot if File.exist?(boot)
+            env = File.join(root, 'config', 'environment.rb')
+            require env if File.exist?(env)
+            dev = File.join(root, 'config', 'development.rb')
+            require dev if File.exist?(dev)
+            validate_origen_dev_configuration!
+            ([@application] + Origen.app.plugins).each(&:on_loaded)
+            @application_loaded = true
+            Array(@after_app_loaded_blocks).each { |b| b.call(@application) }
+            @application
           end
-          boot = File.join(root, 'config', 'boot.rb')
-          require boot if File.exist?(boot)
-          env = File.join(root, 'config', 'environment.rb')
-          require env if File.exist?(env)
-          dev = File.join(root, 'config', 'development.rb')
-          require dev if File.exist?(dev)
-          validate_origen_dev_configuration!
-          ([@application] + Origen.app.plugins).each(&:on_loaded)
-          @application_loaded = true
-          Array(@after_app_loaded_blocks).each { |b| b.call(@application) }
-          @application
         end
       end
 

data/lib/origen/application.rb

@@ -31,20 +31,26 @@ module Origen
         # Somehow using the old import system and version file format we can get in here when
         # loading the version, this can be removed in future when the imports API is retired
         unless caller[0] =~ /version.rb.*/
-          root = Pathname.new(caller[0].sub(/(\\|\/)?config(\\|\/)application.rb.*/, '')).realpath
-          app = base.instance
-          app.root = root.to_s
-          if Origen.plugins_loaded? && !Origen.loading_top_level?
-            # This situation of a plugin being loaded after the top-level app could occur if the app
-            # doesn't require the plugin until later, in that case there is nothing the plugin owner
-            # can do and we just need to accept that this can happen.
-            # Origen.log.warning "The #{app.name} plugin is using a non-standard loading mechanism, upgrade to a newer version of it to get rid of this warning (please report a bug to its owner if this warning persists)"
+          if base.to_s == 'OrigenGlobalApplication'
+            app = base.instance
+            app.root = Origen.root
             Origen.register_application(app)
-            # Origen.app.plugins << app
           else
-            Origen.register_application(app)
+            root = Pathname.new(caller[0].sub(/(\\|\/)?config(\\|\/)application.rb.*/, '')).realpath
+            app = base.instance
+            app.root = root.to_s
+            if Origen.plugins_loaded? && !Origen.loading_top_level?
+              # This situation of a plugin being loaded after the top-level app could occur if the app
+              # doesn't require the plugin until later, in that case there is nothing the plugin owner
+              # can do and we just need to accept that this can happen.
+              # Origen.log.warning "The #{app.name} plugin is using a non-standard loading mechanism, upgrade to a newer version of it to get rid of this warning (please report a bug to its owner if this warning persists)"
+              Origen.register_application(app)
+              # Origen.app.plugins << app
+            else
+              Origen.register_application(app)
+            end
+            app.add_lib_to_load_path!
           end
-          app.add_lib_to_load_path!
         end
       end
 
@@ -372,15 +378,19 @@ END
     def version(options = {})
       @version = nil if options[:refresh]
       return @version if @version
-      load File.join(root, 'config', 'version.rb')
-      if defined? eval(namespace)::VERSION
-        @version = Origen::VersionString.new(eval(namespace)::VERSION)
+      if Origen.running_globally?
+        @version = Origen.version
       else
-        # The eval of the class is required here as somehow when plugins are imported under the old
-        # imports system and with the old version file format we can end up with two copies of the
-        # same class constant. Don't understand it, but it is fixed with the move to gems and the
-        # namespace-based version file format.
-        @version = Origen::VersionString.new(eval(self.class.to_s)::VERSION)
+        load File.join(root, 'config', 'version.rb')
+        if defined? eval(namespace)::VERSION
+          @version = Origen::VersionString.new(eval(namespace)::VERSION)
+        else
+          # The eval of the class is required here as somehow when plugins are imported under the old
+          # imports system and with the old version file format we can end up with two copies of the
+          # same class constant. Don't understand it, but it is fixed with the move to gems and the
+          # namespace-based version file format.
+          @version = Origen::VersionString.new(eval(self.class.to_s)::VERSION)
+        end
       end
       @version
     end

data/lib/origen/application/deployer.rb

@@ -61,7 +61,9 @@ module Origen
       # which is will build and checkout as required
       def git_repo
         @git_repo ||= begin
-          local = Pathname.new("#{Origen.app.workspace_manager.imports_directory}/git/#{Origen.config.web_directory.gsub('/', '-').symbolize}")
+          local_path = "#{Origen.config.web_directory.gsub('/', '-').symbolize}"
+          local_path.gsub!(':', '-') if Origen.os.windows?
+          local = Pathname.new("#{Origen.app.workspace_manager.imports_directory}/git/#{local_path}")
           if git_sub_dir
             remote = Origen.config.web_directory.sub("\/#{git_sub_dir}", '')
           else

data/lib/origen/application/runner.rb

@@ -228,14 +228,16 @@ module Origen
         # submitted the job.
         Origen.file_handler.set_output_directory(options.merge(create: Origen.running_locally?))
         Origen.file_handler.set_reference_directory(options.merge(create: Origen.running_locally?))
-        tmp = "#{Origen.root}/tmp"
-        FileUtils.mkdir(tmp) unless File.exist?(tmp)
-        if Origen.running_locally?
-          mkdir Origen::Log.log_file_directory
-          mkdir "#{Origen.root}/.lsf"
-        end
-        if options[:lsf]
-          mkdir Origen.app.lsf_manager.log_file_directory
+        unless Origen.running_globally?
+          tmp = "#{Origen.root}/tmp"
+          FileUtils.mkdir(tmp) unless File.exist?(tmp)
+          if Origen.running_locally?
+            mkdir Origen::Log.log_file_directory
+            mkdir "#{Origen.root}/.lsf"
+          end
+          if options[:lsf]
+            mkdir Origen.app.lsf_manager.log_file_directory
+          end
         end
       end
 

data/lib/origen/chip_mode.rb

@@ -46,7 +46,7 @@ module Origen
           # The data rate unit was validated on init so it is good to go
           # in theory but should still check if it returns a numeric
           value = @data_rate.send(@data_rate_unit.to_sym)
-          if [Fixnum, Bignum, Float, Integer, Numeric].include? value.class
+          if value.is_a?(Numeric)
             return value
           else
             Origen.log.error "@data_rate '#{@data_rate}' conversion using @data_rate_unit '#{@data_rate_unit}' did not product a Numeric, exiting..."

data/lib/origen/commands.rb

@@ -217,7 +217,7 @@ if shared_commands && shared_commands.size != 0
 end
 
 # Get a list of registered plugins and get the global launcher
-@global_launcher = Origen._applications_lookup[:name].map do |plugin_name, plugin|
+@global_launcher = Origen._applications_lookup[:name].dup.map do |plugin_name, plugin|
   shared = plugin.config.shared || {}
   if shared[:global_launcher]
     file = "#{plugin.root}/#{shared[:global_launcher]}"
@@ -253,6 +253,8 @@ else
 Usage: origen COMMAND [ARGS]
 
 The core origen commands are:
+  EOT
+  cmds = <<-EOT
  environment  Display or set the environment (short-cut alias: "e")
  target       Display or set the target (short-cut alias: "t")
  mode         Display or set the mode (short-cut alias: "m")
@@ -269,32 +271,42 @@ The core origen commands are:
  web          Web page tools, see -h for details
  time         Tools for test time analysis and forecasting
  lint         Lint and style check (and correct) your application code
-
   EOT
+  cmds.split(/\n/).each do |line|
+    puts Origen.clean_help_line(line)
+  end
+  puts
   if @application_commands && !@application_commands.empty?
-    puts <<-EOT
-In addition to these the application has added:
-#{@application_commands}
-EOT
+    puts 'In addition to these the application has added:'
+    @application_commands.split(/\n/).each do |cmds|
+      cmds.split(/\n/).each do |line|
+        puts Origen.clean_help_line(line)
+      end
+    end
+    puts
   end
 
   if @plugin_commands && !@plugin_commands.empty?
     puts 'The following commands are provided by plugins:'
-    @plugin_commands.each do |str|
-      puts str
+    @plugin_commands.each do |cmds|
+      cmds.split(/\n/).each do |line|
+        puts Origen.clean_help_line(line)
+      end
     end
+    puts
   end
 
   if @global_launcher && !@global_launcher.empty?
-    puts ''
     puts 'The following global commands are provided by plugins:'
-    @global_commands.each do |str|
-      puts str
+    @global_commands.each do |cmds|
+      cmds.split(/\n/).each do |line|
+        puts Origen.clean_help_line(line)
+      end
     end
+    puts
   end
 
   puts <<-EOT
-
 All commands can be run with -d (or --debugger) to enable the debugger.
 All commands can be run with --coverage to enable code coverage.
 Many commands can be run with -h (or --help) for more information.

data/lib/origen/commands/version.rb

@@ -1,2 +1,2 @@
-puts "Application: #{Origen.app.version}" if Origen.app_loaded?
+puts "Application: #{Origen.app.version}" if Origen.app_loaded? && !Origen.running_globally?
 puts "     Origen: #{Origen.version}"

data/lib/origen/commands_global.rb

@@ -23,10 +23,29 @@ if ENV['BUNDLE_GEMFILE']
   Bundler.require(:development)
   Bundler.require(:runtime)
   Bundler.require(:default)
+else
+  # If we're not running from a Bundler build, which we aren't here,
+  # get a list of installed system gems. Go through this list finding and get any that has a dependency
+  # on Origen. If so, assume that gem is a plugin.
+  # For all plugins, require it to register as a plugin.
+  # The global handler below will take it from there.
+  Gem::Specification.each do |gem|
+    gem.dependencies.each do |d|
+      if d.name == 'origen'
+        require gem.name
+      end
+    end
+  end
 end
 
+# Load the global app and an empty target, this helps to ensure that all of Origen's functionality
+# is available to global commands, since many features implicitly assume the presence of an app
+Origen.app
+Origen.target.temporary = -> {}
+Origen.load_target
+
 # Get a list of registered plugins and get the global launcher
-@global_launcher = Origen._applications_lookup[:name].map do |plugin_name, plugin|
+@global_launcher = Origen._applications_lookup[:name].dup.map do |plugin_name, plugin|
   shared = plugin.config.shared || {}
   if shared[:global_launcher]
     file = "#{plugin.root}/#{shared[:global_launcher]}"
@@ -90,25 +109,30 @@ else
 Usage: origen COMMAND [ARGS]
 
 The following commands are available:
+  EOT
+  cmds = <<-EOT
  new          Create a new Origen application or plugin. "origen new my_app" creates a
               new origen application workspace in "./my_app"
  interactive  Start an interactive Origen console (short-cut alias: "i"), this is just
               IRB with the 'origen' lib loaded automatically
   EOT
-
+  cmds.split(/\n/).each do |line|
+    puts Origen.clean_help_line(line)
+  end
+  puts
   if @global_launcher && !@global_launcher.empty?
-    puts ''
     puts 'The following global commands are provided by plugins:'
-    @global_commands.each do |str|
-      puts str
+    @global_commands.each do |cmds|
+      cmds.split(/\n/).each do |line|
+        puts Origen.clean_help_line(line)
+      end
     end
+    puts
   end
 
   puts <<-EOT
-
 Many commands can be run with -h (or --help) for more information.
+
   EOT
-  # fetch        Automatically creates the workspace for the requested plugin and
-  #              populates the latest version of the plugin (short-cut alias: "f")
   exit 0
 end