origen 0.2.6 → 0.3.0

data/lib/origen/application/plugins_manager.rb

@@ -1,279 +1,41 @@
 module Origen
   class Application
+    # This module is deprecated and is replaced by Origen::Application::Plugins
     class PluginsManager
-      # Returns the temporary plugin instance if set, otherwise nil
-      attr_reader :temporary
-
-      # Returns the current plugin instance, this will be the temporary plugin if set, if
-      # not then the current default plugin if set, otherwise nil
-      def current
-        if @disabled || @set_to_nil
-          nil
-        else
-          temporary || default
-        end
-      end
-      alias_method :instance, :current
-      alias_method :current_plugin_instance, :current
-
-      def disable
-        @disabled = true
-      end
-
-      def enable
-        @disabled = false
-      end
+      # ***********************************************************************
+      # ***********************************************************************
+      # Don't add anything new here, use origen/application/plugins.rb instead
+      # ***********************************************************************
+      # ***********************************************************************
 
       # Returns the current plugin name, equivalent to calling current.name
       def name
-        current ? current.name : nil
+        Origen.deprecated 'Origen.current_plugin.name is deprecated, use Origen.app.plugins.name instead'
+        if Origen.app.plugins.current
+          Origen.app.plugins.current.name
+        end
       end
 
       # Sets the given plugin as the temporary current plugin, this will last until
       # changed or the end of the current Origen thread
       def temporary=(plugin_name)
-        if !plugin_name || plugin_name.to_sym == :none
-          @set_to_nil = true
-          @temporary = nil
-        else
-          @set_to_nil = false
-          @temporary = find_plugin!(plugin_name)
-        end
+        Origen.deprecated 'Origen.current_plugin.temporary= is deprecated, use Origen.app.plugins.temporary= instead'
+        Origen.app.plugins.temporary = plugin_name
       end
 
       # Same as temporary= except it will be remembered in the next Origen thread.
       # Setting this will also clear any temporary assignment that is currently in
       # effect.
       def default=(plugin_name)
-        self.temporary = nil
-        if !plugin_name || plugin_name.to_sym == :none
-          @default = nil
-        else
-          @default = find_plugin!(plugin_name)
-          Origen.app.session.origen_core[:default_plugin] = @default.name
-          @default
-        end
+        Origen.deprecated 'Origen.current_plugin.default= is deprecated, use Origen.app.plugins.current= instead'
+        Origen.app.plugins.current = plugin_name
       end
 
       # Returns the current plugin instance currently set as the default plugin,
       # otherwise nil
       def default
-        return @default if @default
-        if name = Origen.app.session.origen_core[:default_plugin]
-          begin
-            @default = find_plugin!(name)
-          rescue
-            # Hit here if what has been set to the default plugin has since been
-            # removed from the application
-            self.default = :none
-            nil
-          end
-        end
-      end
-
-      # Checks the given plugin name with the list of installed plugins
-      # and returns true if found else returns false
-      def valid_plugin_name?(plugin_name)
-        Origen.import_manager.names.include?(plugin_name)
-      end
-
-      # Lists all the plugins available on server
-      def list
-        puts 'The following plugins are available to add to your application:'
-        puts ''
-        Origen.client.plugins.group_by { |p| p[:category] }.sort_by { |k, _v| k }.each do |category, plugins|
-          puts category.upcase
-          puts '=' * category.length
-          plugins.sort_by { |p| p[:name] }.each do |plugin|
-            line =  "#{plugin[:origen_name]}".ljust(25) + plugin[:name].strip.ljust(30)
-            if plugin[:latest_version_prod] || plugin[:latest_version_dev]
-              line += [plugin[:latest_version_prod] || plugin[:latest_version_dev]].compact.join(', ')
-            end
-            puts line
-          end
-          puts ''
-        end
-      end
-
-      # Updates the plugin to the supplied version
-      def update(plugin_name, version)
-        if plugin_name.class != Symbol
-          plugin_name = plugin_name.to_sym
-        end
-        if valid_plugin_name?(plugin_name)
-          update_config_file!(version:     version,
-                              plugin_name: plugin_name,
-                              action:      :update)
-        else
-          puts "Plugin #{plugin_name} not found in this app!"
-        end
-      end
-
-      # Adds the given plugin to the current app
-      def add(plugin_name, version, options)
-        if plugin_name.class != Symbol
-          plugin_name = plugin_name.to_sym
-        end
-        if !valid_plugin_name?(plugin_name)
-          plugin_data = read_plugin_info_from_server(plugin_name)
-          update_config_file!(vault:       plugin_data[:vault],
-                              version:     version,
-                              plugin_name: plugin_name,
-                              action:      :add,
-                              dev_import:  options[:dev_import])
-
-          puts 'Plugin added successfully!'
-        else
-          puts "Plugin #{plugin_name} is already included in this app!"
-        end
-      end
-
-      def remove(plugin_name)
-        if plugin_name.class != Symbol
-          plugin_name = plugin_name.to_sym
-        end
-        if valid_plugin_name?(plugin_name)
-          update_config_file!(plugin_name: plugin_name,
-                              action:      :remove)
-          if File.exist?("#{imports_dir}/#{plugin_name}")
-            FileUtils.rm_rf("#{imports_dir}/#{plugin_name}")
-            puts "Plugin '#{plugin_name}' removed successfully!"
-          end
-        else
-          puts "Plugin #{plugin_name} not found in this app!"
-        end
-      end
-
-      # Lists out the currently added plugins within the app on console
-      def list_added_plugins
-        puts 'The following plugins are included in this app:'
-        format = "%30s\t%30s\t%30s\n"
-        printf(format, 'Origen_Name', 'Name', 'Version')
-        printf(format, '---------', '----', '-------')
-
-        Origen.plugins.sort_by { |p| p.name.to_s }.each do |plugin|
-          printf(format, plugin.name, plugin.config.name, plugin.version)
-        end
-        puts ''
-      end
-
-      # Describes the plugin
-      def describe(plugin_name)
-        if plugin_name
-          if plugin_name.class != Symbol
-            plugin_name = plugin_name.to_sym
-          end
-          description = nil
-          Origen.client.plugins.each do |plugin|
-            if plugin[:origen_name].to_sym == plugin_name
-              description = <<-EOT
-Origen_Name:    #{plugin[:origen_name]}
-Actual Name:  #{plugin[:name]}
-Category:     #{plugin[:category]}
-Description:  #{plugin[:description]}
-EOT
-              break
-            end
-          end
-          if description.nil?
-            puts "Plugin #{plugin_name} not found or it does not include a description"
-            exit 1
-          end
-          description
-        else
-          puts 'No plugin name provided'
-          exit 1
-        end
-      end
-
-      private
-
-      def find_plugin!(name)
-        plugin = Origen.plugins.find { |p| p.name.to_sym == name.to_sym }
-        return plugin if plugin
-        puts ''
-        puts "No plugin named '#{name}' is included in this application!"
-        puts 'The plugins currently available are:'
-        Origen.plugins.each do |plugin|
-          puts "  #{plugin.name}"
-        end
-        puts ''
-        fail 'Missing plugin error!'
-      end
-
-      def read_plugin_info_from_server(plugin_name)
-        plugin_data = nil
-        Origen.client.plugins.each do |plugin|
-          if plugin[:origen_name].to_sym == plugin_name
-            plugin_data = plugin
-            break
-          end
-        end
-
-        if plugin_data.nil?
-          fail "No plugin with name #{plugin_name} found!"
-        end
-        plugin_data
-      end
-
-      def update_config_file!(options = {})
-        file = "#{Origen.root}/config/application.rb"
-        lines = File.readlines(file)
-        if options[:action] == :add && !valid_plugin_name?(options[:plugin_name])
-          if options[:dev_import]
-            unless lines.find_index { |line| line =~ /config.imports_dev/ }
-              index = lines.find_index { |line| line =~ /config.vault =/ }
-              lines.insert(index + 1, '  config.imports_dev = [', '', '  ]')
-            end
-          else
-            unless lines.find_index { |line| line =~ /config.imports\s=\s/ }
-              index = lines.find_index { |line| line =~ /config.vault =/ }
-              lines.insert(index + 1, '  config.imports = [', '', '  ]')
-            end
-          end
-
-          File.open(file, 'w') do |f|
-            lines.each do |line|
-              f.puts line
-              if line =~ (options[:dev_import] ? (/config.imports_dev\s=\s/) : (/config.imports\s=\s/))
-                f.puts '    {'
-                f.puts "      :vault => \"#{options[:vault]}\","
-                f.puts "      :version => \"#{options[:version]}\","
-                if (options[:dev_import] ? (Origen.config.imports_dev) : (Origen.config.imports)).size == 0
-                  f.puts '    }'
-                else
-                  f.puts '    },'
-                end
-              end
-            end
-          end
-        elsif options[:action] == :remove && valid_plugin_name?(options[:plugin_name])
-          lines.slice!(plugin_index_range(lines, options))
-          File.open(file, 'w') { |f| lines.each { |line| f.puts line } }
-        elsif options[:action] == :update && valid_plugin_name?(options[:plugin_name])
-          range = plugin_index_range(lines, options)
-          version_index = lines[range].find_index { |line| line =~ /:version/ }
-          version_index += range.first
-          lines[version_index] = "      :version => \"#{options[:version]}\","
-          File.open(file, 'w') { |f| lines.each { |line| f.puts line } }
-        end
-        load "#{Origen.root}/config/application.rb"
-        Origen.import_manager.required = false
-        Origen.import_manager.require!
-      end
-
-      def plugin_index_range(file_lines, options)
-        center = file_lines.find_index { |line| line =~ /:vault(.*)(#{options[:plugin_name]})/i }
-        if center
-          first = file_lines[0..center].length - 1 - file_lines[0..center].rindex.find_index { |line| line =~ /^(\s*)({)(\s*)$/ }
-          last = file_lines[center..(file_lines.size - 1)].find_index { |line| line =~ /^\s*}(,?)\s*$/ }
-          last = center + last
-          first..last
-        end
-      end
-
-      def imports_dir
-        Origen.application.workspace_manager.imports_directory
+        Origen.deprecated 'Origen.current_plugin.default is deprecated, use Origen.app.plugins.current instead'
+        Origen.app.plugins.current
       end
     end
   end

data/lib/origen/application/release.rb

@@ -26,10 +26,10 @@ module Origen
       # Release a new application version
       def run(options)
         # Don't want plugin callbacks kicking in during the release process
-        Origen.current_plugin.disable
+        Origen.app.plugins.disable_current
         @options = options
         if authorized?
-          Origen.import_manager.validate_production_status(true)
+          Origen.app.plugins.validate_production_status(true)
           unless Origen.app.rc.local_modifications.empty?
             puts <<-EOT
 Your workspace has local modifications that are preventing the requested action

data/lib/origen/application/runner.rb

@@ -69,7 +69,7 @@ module Origen
                 temporary_plugin_from_options = options[:current_plugin]
                 expand_lists_and_directories(options[:files], options).each do |file|
                   if temporary_plugin_from_options
-                    Origen.current_plugin.temporary = temporary_plugin_from_options
+                    Origen.app.plugins.temporary = temporary_plugin_from_options
                   end
                   case options[:action]
                   when :compile
@@ -83,9 +83,7 @@ module Origen
                   else
                     Origen.generator.generate_pattern(file, options)
                   end
-                  if temporary_plugin_from_options
-                    Origen.current_plugin.default
-                  end
+                  Origen.app.plugins.temporary = nil if temporary_plugin_from_options
                 end
               end
             end

data/lib/origen/commands.rb

@@ -192,7 +192,7 @@ if File.exist? "#{Origen.root}/config/commands.rb"
   end
 end
 
-shared_commands = Origen.import_manager.command_launcher
+shared_commands = Origen.app.plugins.shared_commands
 if shared_commands && shared_commands.size != 0
   shared_commands.each do |file|
     require file
@@ -218,50 +218,10 @@ when 'generate', 'program', 'compile', 'merge', 'interactive', 'target', 'enviro
   require "origen/commands/#{@command}"
   exit 0 unless @command == 'interactive'
 
-when 'upgrade_app'
-  Origen::CodeGenerators.invoke 'bundler', [], config: { type: :application }
-  Origen::CodeGenerators.invoke 'rake', []
-  Origen::CodeGenerators.invoke 'r_spec', ['-f']
-  exit 0
-
-when 'upgrade_plugin'
-  unless Origen.app.version.semantic?
-    puts 'To upgrade to a gem your plugin must switch to semantic (1.2.3) style versioning.'
-    puts
-  end
-  Origen::CodeGenerators.invoke 'semver', []
-  Origen::CodeGenerators.invoke 'gem_setup', []
-  Origen::CodeGenerators.invoke 'bundler', []
-  Origen::CodeGenerators.invoke 'rake', []
-  Origen::CodeGenerators.invoke 'r_spec', ['-f']
-  exit 0
-
 when 'version'
-  Origen.disable_origen_version_check do
-    Origen.load_application(false)
-    require 'origen/commands/version'
-  end
-
-when 'serve'
-  puts '***************************************************************'
-  puts "'origen serve' is deprecated, please use 'origen web serve' instead"
-  puts '***************************************************************'
-  ARGV.unshift 'serve'
-  load 'origen/commands/web.rb'
-
-when 'tag'
-  puts '***************************************************************'
-  puts "'origen tag' is deprecated, please use 'origen rc tag' instead"
-  puts '***************************************************************'
-  ARGV.unshift 'tag'
-  load 'origen/commands/rc.rb'
-
-when 'modifications'
-  puts '***************************************************************'
-  puts "'origen mods' is deprecated, please use 'origen rc mods' instead"
-  puts '***************************************************************'
-  ARGV.unshift 'modifications'
-  load 'origen/commands/rc.rb'
+  Origen.app # Load app
+  require 'origen/commands/version'
+  exit 0
 
 else
   if ['-h', '--help'].include?(@command)

data/lib/origen/commands/compile.rb

@@ -53,8 +53,7 @@ opt_parser.parse! ARGV
 options[:patterns] = ARGV
 options[:compile] = true  # To let the generator know a compile job has been requested
 
-Origen.load_application
-Origen.current_plugin.temporary = options[:current_plugin] if options[:current_plugin]
+Origen.app.plugins.temporary = options[:current_plugin] if options[:current_plugin]
 Origen.environment.temporary = options[:environment] if options[:environment]
 Origen.target.temporary = options[:target] if options[:target]
 Origen.app.load_target!

data/lib/origen/commands/generate.rb

@@ -52,7 +52,7 @@ if options[:project]
 end
 
 _with_doc_tester(options) do
-  Origen.current_plugin.temporary = options[:current_plugin] if options[:current_plugin]
+  Origen.app.plugins.temporary = options[:current_plugin] if options[:current_plugin]
   Origen.environment.temporary = options[:environment] if options[:environment]
   Origen.target.temporary = options[:target] if options[:target]
   Origen.app.load_target!  # This initial load is required to apply any configuration

data/lib/origen/commands/interactive.rb

@@ -47,8 +47,7 @@ Usage: origen i [options]
   end
   opt_parser.parse! ARGV
 
-  Origen.load_application
-  Origen.current_plugin.temporary = options[:current_plugin] if options[:current_plugin]
+  Origen.app.plugins.temporary = options[:current_plugin] if options[:current_plugin]
   Origen.environment.temporary = options[:environment] if options[:environment]
   Origen.target.temporary = options[:target] if options[:target]
   Origen.app.load_console

data/lib/origen/commands/plugin.rb

@@ -8,28 +8,20 @@ opt_parser = OptionParser.new do |opts|
   opts.banner = <<-EOT
 Usage:  origen pl
         origen pl [plugin name]
-        origen pl [CMD] [plugin name] [options]
+        origen pl [CMD] [options]
 
 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 [plugin_name]               # Sets the specified plugin as current plugin
   origen pl reset                       # Resets the current plugin to none
-  origen pl describe plugin_name        # Describes the specified plugin
-  origen pl add plugin_name va.b.c.dev0 # Adds the plugin of version va.b.c.dev0
 
 The following commands are available:
 
-  list                                Displays all known plugins from the server
   added                               Displays all plugins that are currently included in this app locally
-  describe [plugin_name]              Describes the plugin
-  add [plugin_name] [version]         Adds the specified plugin if found on server to the local app
-  remove [plugin_name]                Removes the specified plugin from this local app
-  update [plugin_name] [version]      Updates the specific plugin to the given version
 
 The following options are available:
   EOT
-  opts.on('--dev', 'Adds the plugin to config.imports_dev rather that config.imports') { options[:dev_import] = true }
   opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
   opts.on('-h', '--help', 'Show this message') { puts opts; exit }
 end
@@ -37,8 +29,8 @@ end
 opt_parser.parse! ARGV
 
 if !ARGV[0]
-  if Origen.current_plugin.default
-    puts "Current plugin is: #{Origen.current_plugin.name}"
+  if Origen.app.plugins.current
+    puts "Current plugin is: #{Origen.app.plugins.current.name}"
   else
     puts <<-EOT
 No plugin set!
@@ -50,56 +42,57 @@ To work with an included plugin, set it as current plugin using the following co
 else
   case input = ARGV.shift
   when 'reset', 'none'
-    Origen.current_plugin.default = :none
+    Origen.app.plugins.current = nil
     puts 'Successfully cleared the default plugin!'
-  when 'add'
-    plugin_name = ARGV.shift
-    version = ARGV.shift
-    if plugin_name && version
-      Origen.plugins_manager.add(plugin_name, version, options)
-    else
-      puts 'Zero or less arguments provided!'
-    end
+  # when 'add'
+  #  plugin_name = ARGV.shift
+  #  version = ARGV.shift
+  #  if plugin_name && version
+  #    Origen.plugins_manager.add(plugin_name, version, options)
+  #  else
+  #    puts 'Zero or less arguments provided!'
+  #  end
   when 'added'
-    Origen.plugins_manager.list_added_plugins
-  when 'list'
-    Origen.plugins_manager.list
-  when 'describe'
-    puts Origen.plugins_manager.describe(ARGV.shift)
-  when 'remove'
-    plugin_name = ARGV.shift
-    if plugin_name
-      Origen.plugins_manager.remove(plugin_name)
-    else
-      puts 'No plugin name provided!'
-    end
-  when 'update'
-    plugin_name = ARGV.shift
-    version = ARGV.shift
-    if plugin_name && version
-      Origen.plugins_manager.update(plugin_name, version)
-    else
-      puts 'Zero or less arguments provided!'
+    puts 'The following plugins are included in this app:'
+    puts
+    format = "%30s\t%30s\t%30s\n"
+    printf(format, 'Origen_Name', 'Name', 'Version')
+    printf(format, '---------', '----', '-------')
+
+    Origen.app.plugins.sort_by { |p| p.name.to_s }.each do |plugin|
+      printf(format, plugin.name, plugin.config.name, plugin.version)
     end
+    puts
+    exit 0
+
+  # when 'list'
+  #  Origen.plugins_manager.list
+  # when 'describe'
+  #  puts Origen.plugins_manager.describe(ARGV.shift)
+  # when 'remove'
+  #  plugin_name = ARGV.shift
+  #  if plugin_name
+  #    Origen.plugins_manager.remove(plugin_name)
+  #  else
+  #    puts 'No plugin name provided!'
+  #  end
+  # when 'update'
+  #  plugin_name = ARGV.shift
+  #  version = ARGV.shift
+  #  if plugin_name && version
+  #    Origen.plugins_manager.update(plugin_name, version)
+  #  else
+  #    puts 'Zero or less arguments provided!'
+  #  end
 
   else
 
-    Origen.current_plugin.default = input.to_sym
-    puts "#{Origen.current_plugin.default.name} is now set as the current plugin."
+    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."
+    else
+      puts "#{input} is not among this application's plugins, the current plugin is currently cleared!"
+    end
   end
 
 end
-
-# def _workspace_plugin_command
-#  puts 'local'
-# end
-#
-# def _global_plugin_command
-#  puts 'global'
-# end
-
-# if Origen.in_application_directory? || Origen.in_application_subdirectory?
-#    _workspace_plugin_command
-# else
-#    _global_plugin_command
-# end