origen 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bd96773b56519ca3c588ba06ddd2db770a6a3b8
-  data.tar.gz: 68f3a9c05792dde205b99001d9cece88c0d1d98b
+  metadata.gz: de6c14abeb7969c56b039ecae7c2b8895942cc31
+  data.tar.gz: 6537fdfdd336093de65eb0d122902adb9ceb21aa
 SHA512:
-  metadata.gz: 87cb67532f2c74ec3e83ba6502d527517d95a1fd96a6066a9ef11f9675cb0221c951beec990cced059914bd27a7c3e14a90c66fbc0e910b96aed77c5fb8150b5
-  data.tar.gz: 8a1adf271a8d4f3d2f2d0f66be8e92a957ca00278ce4a9557a8b4fec015b106221469754d8dafbc2f782cd4a4728facd533985d3f5e182016b4c38f30564334f
+  metadata.gz: 64d3ca87c62cf25de9082e6ce7c263a504bf1bc6ed7cc06f653989e06cb053a400e194cb3a280dbf6202ee939f1eea57c4fa6cb384d5af57bd24db99971bf07f
+  data.tar.gz: 6c730671056c7bf5d39f04b9dfa0578a1985006d347cf4c2c4a2f19d9bfc944b419f0304b421188573843672136ef4e19c01297a8660c3c0c5d8ac18b13c2cc6

data/config/version.rb

@@ -1,6 +1,6 @@
 module Origen
   MAJOR = 0
-  MINOR = 27
+  MINOR = 28
   BUGFIX = 0
   DEV = nil
 

data/lib/origen.rb

@@ -162,6 +162,10 @@ unless defined? RGen::ORIGENTRANSITION
       end
       alias_method :application!, :app!
 
+      def has_plugin?(plugin)
+        _applications_lookup[:name][plugin.to_sym].nil? ? false : true
+      end
+
       # @api private
       def with_source_file(file)
         @current_source_dir = Pathname.new(file).dirname
@@ -727,6 +731,15 @@ unless defined? RGen::ORIGENTRANSITION
         @lsf ||= Origen::Application::LSF.new
       end
 
+      # Let's Origen know about any domain specific acronyms used with an application, this will cause
+      # them to be translated between underscored and camel-cased versions correctly
+      def register_acronym(name)
+        require 'active_support/core_ext/string/inflections'
+        ActiveSupport::Inflector.inflections(:en) do |inflect|
+          inflect.acronym(name)
+        end
+      end
+
       private
 
       def current_command=(val)

data/lib/origen/application/plugins.rb

@@ -21,6 +21,9 @@ module Origen
               if line =~ /^\s*gem\s+(("|')\w+("|')),.*(:path\s*=>|path:)/
                 fail "The following gem is defined as a path in your Gemfile, but that is not allowed in production: #{Regexp.last_match[1]}"
               end
+              if line =~ /ORIGEN PLUGIN AUTO-GENERATED/
+                fail 'Fetched gems are currently being used in your Gemfile, but that is not allowed in production!'
+              end
             end
           end
         end

data/lib/origen/commands.rb

@@ -228,7 +228,7 @@ end.compact
 
 case @command
 when 'generate', 'program', 'compile', 'merge', 'interactive', 'target', 'environment',
-     'save', 'lsf', 'web', 'time', 'dispatch', 'rc', 'lint', 'plugin', 'fetch', 'mode' # , 'add'
+     'save', 'lsf', 'web', 'time', 'dispatch', 'rc', 'lint', 'plugin', 'fetch', 'mode', 'gem' # , 'add'
 
   require "origen/commands/#{@command}"
   exit 0 unless @command == 'interactive'

data/lib/origen/commands/plugin.rb

@@ -1,4 +1,9 @@
 require 'optparse'
+require 'fileutils'
+require 'rubygems'
+require 'origen/version_string'
+
+include Origen::Utility::InputCapture
 
 options = {}
 
@@ -12,22 +17,110 @@ Usage:  origen pl
 
 Quickstart Examples:
   origen pl                             # Displays the current plugin
-  origen pl added                       # Lists the included plugins
   origen pl [plugin_name]               # Sets the specified plugin as current plugin
   origen pl reset                       # Resets the current plugin to none
+  origen pl added                       # Lists the included Origen plugins
+  origen pl added --all                 # Lists the included Origen plugins and external gem dependencies
+  origen pl fetch [plugin_name]         # Populates plugin/gem source to a local repo (<app_root>/tmp/gems/)
+  origen pl clean [plugin_name|all]     # Removes the local copy of the plugin/gem source
+  origen pl info [plugin_name]          # Get additional details of the plugin
 
 The following commands are available:
 
   added                               Displays all plugins that are currently included in this app locally
+  reset                               Resets the current plugin to none
+  fetch                               Populates plugin/gem source to a local repo (<app_root>/tmp/gems/)
+  clean                               Removes the local copy of the plugin/gem source
+  info                                Displays detailed information about the plugin/gem
 
 The following options are available:
   EOT
+  opts.on('-a', '--allr', 'List all plugins/gems (including external)') {  options[:debugger] = true }
   opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
   opts.on('-h', '--help', 'Show this message') { puts opts; exit }
 end
 
 opt_parser.parse! ARGV
 
+QUIET_ATTRS = %w(
+  files test_files signing_key licenses rdoc_options
+  autorequire cert_chain post_install_message
+)
+
+def self._local_gems
+  gems = {}
+  Gem::Specification.sort_by { |g| [g.name.downcase, g.version] }.group_by(&:name).map do |name, specs|
+    gems[name.to_sym] = {
+      name:     name,
+      version:  specs.map(&:version).join(','),
+      location: specs.map(&:full_gem_path).join(','),
+      authors:  specs.map(&:authors).join(',')
+    }
+  end
+  gems
+end
+
+def self._local_gems_orig
+  Gem::Specification.sort_by { |g| [g.name.downcase, g.version] }.group_by(&:name)
+end
+
+def self._session_gem_path
+  "#{Origen.app.root}/tmp/gems"
+end
+
+def self._application_gemfile
+  "#{Origen.app.root}/Gemfile"
+end
+
+def self._local_path_to_gem(gem)
+  "#{_session_gem_path}/#{Pathname(gem[:location]).basename}"
+end
+
+def self._gem_basename(gem)
+  "#{Pathname(gem[:location]).basename}"
+end
+
+def self._gem_rc_version(gem)
+  gem[:version]
+end
+
+def self._update_gemfile
+  content = File.read(_application_gemfile)
+
+  search_regexp = "# ORIGEN PLUGIN AUTO-GENERATED.*# /ORIGEN PLUGIN AUTO-GENERATED.*?\n"
+
+  if Origen.app.session.gems.keys.empty?
+    new_contents = content.gsub(/#{search_regexp}/m, '')
+  else
+    replacement_string = "# ORIGEN PLUGIN AUTO-GENERATED---------------DO NOT REMOVE THIS LINE-------------\n"
+    replacement_string += "# -- DO NOT CHECK IN WITH THIS SECTION!\n"
+    replacement_string += "# -- DO NOT HAND MODIFY!\n"
+    replacement_string += "# -- USE 'origen pl clean all' to reset\n"
+    replacement_string += "\n"
+
+    Origen.app.session.gems.keys.sort.each do |g|
+      replacement_string += "gem '#{g}', path: '#{Origen.app.session.gems[g.to_sym]}'\n"
+      replacement_string += "puts \"\\e[1;93;40mWARNING: Using session gem for '#{g}'\\e[0m\"\n"
+    end
+
+    replacement_string += "def gem(*args)\n"
+    replacement_string += "  return if [#{Origen.app.session.gems.keys.sort.map { |e| "'" + e.to_s + "'" }.join(',')}].include? args[0]\n"
+    replacement_string += "  super(*args)\n"
+    replacement_string += "end\n"
+    replacement_string += "#\n"
+    replacement_string += "# /ORIGEN PLUGIN AUTO-GENERATED---------------DO NOT REMOVE THIS LINE------------\n"
+
+    if content =~ /#{search_regexp}/m
+      new_contents = content.gsub(/#{search_regexp}/m, replacement_string)
+    else
+      new_contents = replacement_string + content
+    end
+  end
+  File.open(_application_gemfile, 'w') { |file| file.puts new_contents }
+end
+
+gems = _local_gems
+
 if !ARGV[0]
   if Origen.app.plugins.current
     puts "Current plugin is: #{Origen.app.plugins.current.name}"
@@ -64,8 +157,153 @@ else
     end
     puts
     exit 0
+  when 'fetch'
+    gem = ARGV[0]
+    if gem
+      if gems.key?(gem.to_sym)
+        # Initialize ./tmp/gems/
+        FileUtils.mkdir_p(_session_gem_path) unless Dir.exist? _session_gem_path
+
+        if Dir.exist? _local_path_to_gem(gems[gem.to_sym])
+          # check if already exists, ask for permission to blow away
+          puts ''
+          puts "Plugin/Gem '#{_gem_basename(gems[gem.to_sym])}' already exists locally, would you like to replace?"
+          puts "(This will delete and replace the exising copy at #{_local_path_to_gem(gems[gem.to_sym])})"
+          puts ''
+          get_text confirm: true
+          Origen::Log.console_only do
+            Dir.chdir Origen.root do
+              # Blow away these temporary files
+              system("rm -fr #{_local_path_to_gem(gems[gem.to_sym])}")
+            end
+          end
+        end
+
+        if Origen.has_plugin?(gem)
+          # Set up the requested plugin workspace
+          rc_url = Origen.app(gem.to_sym).config.rc_url || Origen.app(gem.to_sym).config.vault
+          if rc_url =~ /git/
+            Origen::RevisionControl::Git.git("clone #{rc_url} #{_gem_basename(gems[gem.to_sym])}", local: _session_gem_path, verbose: true)
+          else
+            # Use Origen::RevisionControl for DesignSync
+            rc = Origen::RevisionControl.new remote: rc_url, local: _local_path_to_gem(gems[gem.to_sym])
+            tag = Origen::VersionString.new(_gem_rc_version(gems[gem.to_sym]))
+            tag = tag.prefixed if tag.semantic?
+            rc.build version: tag
+          end
+        else
+          puts 'Not an Origen plugin, only COPYING source.'
+          FileUtils.cp_r(gems[gem.to_sym][:location], _session_gem_path)
+        end
+
+        # FileUtils.cp_r(gems[gem.to_sym][:location], _session_gem_path)
+        unless options[:dont_use]
+          Origen.app.session.gems[gem.to_sym] = "#{_local_path_to_gem(gems[gem.to_sym])}"
+        end
 
-  # when 'list'
+        _update_gemfile
+
+        puts "Fetched #{gem} to tmp/gems/#{_gem_basename(gems[gem.to_sym])}"
+        puts ''
+      else
+        puts "Error: '#{gem}' is not a currently used plugin/gem.  Use 'origen pl list' for gem list."
+      end
+    else
+      puts "Error: Must specify plugin/gem to be fetched. Use 'origen pl -h' for usage"
+    end
+  when 'clean'
+    gem = ARGV[0]
+    if gem
+      if gem == 'all'
+        if Dir.exist? _session_gem_path
+          puts ''
+          puts 'You are about to delete all local plugin/gems (tmp/gems/).  IS THAT CORRECT?'
+          puts ''
+          get_text confirm: true
+          Origen::Log.console_only do
+            Dir.chdir Origen.root do
+              system("rm -fr #{_session_gem_path}")
+            end
+          end
+          unless Origen.app.session.gems.keys.empty?
+            Origen.app.session.gems.keys.sort.each do |g|
+              Origen.app.session.gems.delete_key(g)
+            end
+            _update_gemfile
+          end
+        else
+          puts 'There are no local plugins/gems present, nothing to clean.'
+        end
+      elsif gems.key?(gem.to_sym)
+        if Dir.exist? _local_path_to_gem(gems[gem.to_sym])
+          # check if already exists, ask for permission to blow away
+          puts ''
+          puts "You are about to delete the local copy of '#{gem}' (tmp/gems/#{_gem_basename(gems[gem.to_sym])}).  IS THAT CORRECT?"
+          puts ''
+          get_text confirm: true
+          Origen::Log.console_only do
+            Dir.chdir Origen.root do
+              system("rm -fr #{_local_path_to_gem(gems[gem.to_sym])}")
+            end
+          end
+          Origen.app.session.gems.delete_key(gem.to_sym)
+          _update_gemfile
+        else
+          puts "Plugin/Gem '#{gem}' is not locally present, nothing to clean."
+        end
+      end
+    else
+      puts "Error: Must specify plugin/gem to be cleaned or 'all'. Use 'origen pl -h' for usage"
+    end
+  when 'info'
+    gem = ARGV[0]
+    if gem
+      if gems.key?(gem.to_sym)
+        a = _local_gems_orig[gem].to_yaml.split(/\n+/)
+        skip = true
+
+        if options[:gem_location] || options[:gem_version]
+          puts '================================================================================='
+          puts "Gem Name: #{gems[gem.to_sym][:name]}"
+          puts "Version:  #{gems[gem.to_sym][:version]}" if options[:gem_version]
+          puts "Location: #{gems[gem.to_sym][:location]}" if options[:gem_location]
+          puts '================================================================================='
+        else
+          puts '================================================================================='
+          puts "Gem Name: #{gems[gem.to_sym][:name]}"
+          puts "Version:  #{gems[gem.to_sym][:version]}"
+          puts "Location: #{gems[gem.to_sym][:location]}"
+          puts '---------------------------------------------------------------------------------'
+          puts 'Details:'
+          a.each do |line|
+            if line =~ /^  (\w+):(.*)$/
+              topic = Regexp.last_match(1)
+              if QUIET_ATTRS.include? topic
+                skip = true
+              else
+                skip = false
+              end
+            end
+            puts "  #{line}" unless skip
+          end
+          puts '---------------------------------------------------------------------------------'
+          puts '================================================================================='
+        end
+      else
+        puts "Error: '#{gem}' not a valid command or plugin/gem. Use 'origen pl -h' for usage or 'origen pl list' for plugin/gem list."
+      end
+    else
+      puts "Error: Must specify plugin/gem for the info command. Use 'origen pl -h' for usage"
+    end
+  when 'list'
+    longest_key = gems.keys.max_by(&:length)
+    puts ''
+    printf "%-#{longest_key.length}s %-15s %s\n", 'Gem', 'Version', 'Location'
+    puts '--------------------------------------------------------------------------------------------------------------'
+    gems.each do |k, v|
+      printf "%-#{longest_key.length}s %-15s %s\n", k, v[:version], v[:location]
+    end
+    puts ''
   #  Origen.plugins_manager.list
   # when 'describe'
   #  puts Origen.plugins_manager.describe(ARGV.shift)
@@ -86,7 +324,6 @@ else
   #  end
 
   else
-
     Origen.app.plugins.current = input.to_sym
     if Origen.app.plugins.current
       puts "#{Origen.app.plugins.current.name} is now set as the current plugin."

data/lib/origen/core_ext.rb

@@ -9,3 +9,4 @@ require 'origen/core_ext/array'
 require 'origen/core_ext/range'
 require 'origen/core_ext/enumerable'
 require 'origen/core_ext/regexp'
+require 'origen/core_ext/symbol'

data/lib/origen/core_ext/numeric.rb

@@ -57,7 +57,7 @@ class Numeric
     end
   end
 
-  %w(Hz hz Ts ts bps sps ohm Ohm a A v V s S).each do |m|
+  %w(Hz hz Ts ts bps sps ohm Ohm a A v V s S f F).each do |m|
     define_method "as_#{m}" do
       as_units(m)
     end
@@ -134,31 +134,31 @@ class Numeric
     end
   end
 
-  %w(v V s S a A Hz Ts Ohm ohm O o).each do |m|
+  %w(v V s S a A Hz Ts Ohm ohm O o f F).each do |m|
     define_method m do
       self
     end
   end
 
-  %w(mv mV ms mS ma mA mo mO mOhm mohm).each do |m|
+  %w(mv mV ms mS ma mA mo mO mOhm mohm mf mF).each do |m|
     define_method m do
       self / 1_000.0
     end
   end
 
-  %w(uv uV us uS ua uA).each do |m|
+  %w(uv uV us uS ua uA uf uF).each do |m|
     define_method m do
       self / 1_000_000.0
     end
   end
 
-  %w(nv nV ns nS na nA).each do |m|
+  %w(nv nV ns nS na nA nf nF).each do |m|
     define_method m do
       self / 1_000_000_000.0
     end
   end
 
-  %w(pv pV ps pS pa pA).each do |m|
+  %w(pv pV ps pS pa pA pf pF).each do |m|
     define_method m do
       self / 1_000_000_000_000.0
     end

data/lib/origen/core_ext/string.rb

@@ -141,6 +141,30 @@ class String
     end
   end
 
+  # Boolean if the string is uppercase
+  # Will not work with odd character sets
+  def is_upcase?
+    self == upcase
+  end
+  alias_method :is_uppercase?, :is_upcase?
+
+  # Boolean if the string is uppercase
+  # Will not work with odd character sets
+  def is_downcase?
+    self == downcase
+  end
+  alias_method :is_lowercase?, :is_downcase?
+
+  # Convert Excel/Spreadsheet column to integer
+  def excel_col_index
+    str = split('').map(&:upcase).join('')
+    offset = 'A'.ord - 1
+    str.chars.inject(0) { |x, c| x * 26 + c.ord - offset }
+  end
+  alias_method :xls_col_index, :excel_col_index
+  alias_method :xlsx_col_index, :excel_col_index
+  alias_method :spreadsheet_col_index, :excel_col_index
+
   private
 
   # Convert a verilog number string to an integer

data/lib/origen/core_ext/symbol.rb

@@ -0,0 +1,5 @@
+class Symbol
+  def smatch(regexp)
+    to_s.match(regexp)
+  end
+end

data/lib/origen/model.rb

@@ -7,6 +7,8 @@ module Origen
   module Model
     extend ActiveSupport::Concern
 
+    autoload :Exporter, 'origen/model/exporter'
+
     included do
       attr_writer :ip_name
       attr_accessor :version
@@ -29,6 +31,7 @@ module Origen
       include Origen::Tests
       include Origen::PowerDomains
       include Origen::Clocks
+      include Origen::Model::Exporter
     end
 
     module ClassMethods