origen_app_generators 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12f932a68b79d412af20be670cbc65b00a46a070
-  data.tar.gz: 1fbdec258c274fc187afabddf0541a3168db5650
+  metadata.gz: 3267cade6967ba2fa712fb084cd0660b34ee61fe
+  data.tar.gz: 2c99338c64db4b6a59af834dd1525d79f3ffa8be
 SHA512:
-  metadata.gz: 76cb92b2edd4ee49d245e7a560aa98faaee5907c6e5b26dc7062b22e532a893ae5eb11ab8830616a55807dfdb34ada4706935b1b89df8d30df51d1ceab0ec4d2
-  data.tar.gz: f58c7cb74b8af6159e2c65cd672e37ad23f357b66b7de8a372b890898262ce8df93a4822d1c6bf68e29d45b4c7fc1d9fb6cb7de39e397a4c424da535033c92cf
+  metadata.gz: 284643c48009e92e6782ec77d4efdf0320ea40b54e20926ade478e6f03b29e961bd8e22145c1829153a96379af602fa3fd7f89d0cc9a5cbe5d2e297249d59e82
+  data.tar.gz: ec620150afb77da7dec26efde4eba7a498acb0298a5147e5efec3cabb43addc35fb9ef200f56ccbaec11c667a0d68c941857a4366412b40aa59592a6da88c0fb

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenAppGenerators
   MAJOR = 0
-  MINOR = 1
+  MINOR = 2
   BUGFIX = 0
   DEV = nil
 

data/lib/origen_app_generators.rb

@@ -3,8 +3,8 @@ require 'colored'
 require 'origen_app_generators/base'
 require 'origen_app_generators/application'
 require 'origen_app_generators/plugin'
-require 'origen_app_generators/generic_application'
-require 'origen_app_generators/generic_plugin'
+require 'origen_app_generators/empty_application'
+require 'origen_app_generators/empty_plugin'
 require 'origen_app_generators/new'
 require 'origen_app_generators/test_engineering/test_block'
 require 'origen_app_generators/test_engineering/stand_alone_application'
@@ -13,9 +13,9 @@ module OrigenAppGenerators
   extend Origen::Utility::InputCapture
 
   TEST_INPUTS = [
-    # Generic app
+    # Empty app
     ['0', '0', :default, :default, []],
-    # Generic plugin
+    # Empty 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']]
@@ -25,7 +25,7 @@ module OrigenAppGenerators
   # generally speaking don't, use 'rake new' to create a new generator instead
   AVAILABLE = {
     'Test Engineering' => [
-      OrigenAppGenerators::TestEngineering::TestBlock,
+      # OrigenAppGenerators::TestEngineering::TestBlock,
       OrigenAppGenerators::TestEngineering::StandAloneApplication
     ]
   }
@@ -38,7 +38,7 @@ module OrigenAppGenerators
     puts
     i = 0
     accept = [0]
-    puts '0 - Generic / Not listed'
+    puts '0 - Empty / Not listed'
     AVAILABLE.reverse_each do |domain, _generators|
       i += 1
       accept << i
@@ -58,9 +58,9 @@ module OrigenAppGenerators
 
       case selection
       when 0
-        OrigenAppGenerators::GenericApplication.start [path]
+        OrigenAppGenerators::EmptyApplication.start [path]
       when 1
-        OrigenAppGenerators::GenericPlugin.start [path]
+        OrigenAppGenerators::EmptyPlugin.start [path]
       end
     else
       domain = AVAILABLE.to_a

data/lib/origen_app_generators/application.rb

@@ -30,15 +30,15 @@ module OrigenAppGenerators
         config_boot:        { source: 'config/boot.rb' },
         config_commands:    { source: 'config/commands.rb' },
         doc_history:        { source: 'doc/history' },
-        target_debug:       { source: 'target/debug.rb' },
-        target_production:  { source: 'target/production.rb' },
-        target_default:     { source: 'debug.rb',          # Relative to the file being linked to
-                              dest:   'target/default.rb', # Relative to destination_root
-                              type:   :symlink },
+        target_default:     { source: 'target/default.rb' },
+        # target_default:     { source: 'debug.rb',          # Relative to the file being linked to
+        #                      dest:   'target/default.rb', # Relative to destination_root
+        #                      type:   :symlink },
+        environment_dir:    { dest: 'environment', type: :directory },
         lib_module:         { source: 'lib/module.rb',
                               dest:   "lib/#{@name}.rb" },
-        lib_top_level:      { source: 'lib/top_level.rb',
-                              dest:   "lib/#{@name}/top_level.rb" },
+        # lib_top_level:      { source: 'lib/top_level.rb',
+        #                      dest:   "lib/#{@name}/top_level.rb" },
         lib_tasks:          { source: 'lib/app.rake',
                               dest:   "lib/tasks/#{@name}.rake" },
         spec_helper:        { source: 'spec/spec_helper.rb' },
@@ -58,7 +58,7 @@ module OrigenAppGenerators
         gitignore:          { source: '.gitignore' },
         irbrc:              { source: '.irbrc' },
         rspec:              { source: '.rspec' },
-        # This sets the default mode of the new workspace to 'default'
+        # This sets the default mode of the new workspace to 'debug'
         session:            { source: 'origen_core_session',
                               dest:   '.session/origen_core',
                               copy:   true

data/lib/origen_app_generators/{generic_application.rb → empty_application.rb}

@@ -1,6 +1,6 @@
 module OrigenAppGenerators
   # Generates a generic application shell
-  class GenericApplication < Application
+  class EmptyApplication < Application
     # Any methods that are not protected will get invoked in the order they are
     # defined when the generator is run
 

data/lib/origen_app_generators/{generic_plugin.rb → empty_plugin.rb}

@@ -1,6 +1,6 @@
 module OrigenAppGenerators
   # Generates a generic plugin shell
-  class GenericPlugin < Plugin
+  class EmptyPlugin < Plugin
     # Any methods that are not protected will get invoked in the order they are
     # defined when the generator is run
 

data/lib/tasks/app_generators.rake

@@ -31,7 +31,8 @@ end
 desc 'Test that all generators build'
 task :regression do
   OrigenAppGenerators::TEST_INPUTS.each do |inputs|
-    commands = ['origen -v'] + inputs.pop
+    # Test that origen and the console can boot in the new app
+    commands = ['origen -v', 'origen lint', 'rake new_app_tests:load_target'] + inputs.pop
     if ENV['TRAVIS'] && ENV['CONTINUOUS_INTEGRATION']
       prefix = 'bundle && bundle exec '
     end
@@ -41,14 +42,19 @@ task :regression do
       Origen.app.stats.report_fail
       exit 1
     end
+    # Copy the new app test rake tasks to the new app
+    t = File.expand_path('../new_app_tests.rake', Pathname.new(__FILE__).realpath)
+    FileUtils.cp t, 'tmp/lib/tasks'
     # Test the app can boot
     Bundler.with_clean_env do
       Dir.chdir 'tmp' do
         commands.each do |command|
+          Origen.log.info "Running command: #{command}"
           unless system("#{prefix}#{command}")
             Origen.app.stats.report_fail
             exit 1
           end
+          Origen.log.success "Command passed: #{command}"
         end
       end
     end

data/lib/tasks/new_app_tests.rake

@@ -0,0 +1,6 @@
+namespace :new_app_tests do
+  desc 'Test that the app and default target can load'
+  task :load_target do
+    Origen.app.target.load!
+  end
+end

data/templates/app_generators/application/Rakefile

@@ -1,5 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/app_tasks.rake, and they will automatically be available to Rake.
+# for example lib/tasks/<%= @name %>.rake, and they will automatically
+# be available to Rake.
 require "bundler/setup"
 require "origen"
 

data/templates/app_generators/application/config/application.rb

@@ -1,7 +1,7 @@
 require 'origen'
 class <%= @namespace %>Application < Origen::Application
 
-  # See http://origen-sdk.org/origen/latest/api/Origen/Application/Configuration.html
+  # See http://origen-sdk.org/origen/api/Origen/Application/Configuration.html
   # for a full list of the configuration options available
 
   # These attributes should never be changed, the duplication here will be resolved in future
@@ -10,15 +10,25 @@ class <%= @namespace %>Application < Origen::Application
   self.namespace  = "<%= @namespace %>"
   config.name     = "<%= @name %>"
   config.initials = "<%= @namespace %>"
-  config.rc_url   = "" 
+  # Change this to point to the revision control repository for this <%= @type %>
+<% if @audience == :external -%>
+  #config.rc_url   = "ssh://git@github.com:myaccount/<%= @name %>.git" 
+<% else -%>
+  #config.rc_url   = "ssh://git@sw-stash.mycompany.net/myproject/<%= @name %>.git"
+<% end -%>
 <% if @audience == :external -%>
   config.release_externally = true
 <% end -%>
 
   # To enable deployment of your documentation to a web server (via the 'origen web'
   # command) fill in these attributes.
-  config.web_directory = "/proj/.web_origen/html/<%= @name %>"
-  config.web_domain = "http://origen-sdk.org/<%= @name %>"
+<% if @audience == :external -%>
+  #config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/<%= @name %>"
+  #config.web_domain = "http://origen-sdk.org/<%= @name %>"
+<% else -%>
+  #config.web_directory = "/path/to/server/<%= @name %>"
+  #config.web_domain = "http://origen.mycompany.net/<%= @name %>"
+<% end -%>
 
   # When false Origen will be less strict about checking for some common coding errors,
   # it is recommended that you leave this to true for better feedback and easier debug.
@@ -64,12 +74,12 @@ class <%= @namespace %>Application < Origen::Application
   #end
  
   # This will automatically deploy your documentation after every tag
-  def after_release_email(tag, note, type, selector, options)
-    command = "origen web compile --remote --api"
-    Dir.chdir Origen.root do
-      system command
-    end
-  end
+  #def after_release_email(tag, note, type, selector, options)
+  #  command = "origen web compile --remote --api"
+  #  Dir.chdir Origen.root do
+  #    system command
+  #  end
+  #end
 
   # Ensure that all tests pass before allowing a release to continue
   #def validate_release

data/templates/app_generators/application/lib/module.rb

@@ -1,17 +1,15 @@
 require 'origen'
 <% if @type == :plugin -%>
-require_relative '../config/application.rb'     
+require_relative '../config/application.rb'
 <% end -%>
 module <%= @namespace %>
-
   # Load all files in the lib directory via a wildcard, if your project becomes
   # large or load order dependencies start to creep in then you may need to
   # start taking control of this manually as described above.
   # Note that there is no problem from requiring a file twice (Ruby will ignore
   # the second require), so if you have a file that must be required up front
   # you can do that one manually and the let the wildcard take care of the rest.
-  Dir.glob("#{File.dirname(__FILE__)}/**/*.rb").sort.each do |file| 
+  Dir.glob("#{File.dirname(__FILE__)}/**/*.rb").sort.each do |file|
     require file
   end
-
 end

data/templates/app_generators/application/spec/spec_helper.rb

@@ -22,61 +22,7 @@ require "origen"
 
 require "rspec/legacy_formatters"
 require "#{Origen.top}/spec/format/origen_formatter"
-
-if RUBY_VERSION >= '2.0.0'
-  require "byebug"
-else
-  require 'debugger'
-end
-require 'pry'
-
-def load_target(target="default")
-  Origen.target.switch_to target
-  Origen.target.load!
-end
-
-RSpec.configure do |config|
-  config.formatter = OrigenFormatter
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # Enable only the newer, non-monkey-patching expect syntax.
-    # For more details, see:
-    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-    expectations.syntax = :should
-  end
-end
-$VERBOSE=nil  # Don't care about world writable dir warnings and the like
-
-require 'pathname'
-if File.exist? File.expand_path("../Gemfile", Pathname.new(__FILE__).realpath)
-  require 'rubygems'
-  require 'bundler/setup'
-else
-  # If running on windows, can't use Origen helpers 'till we load it...
-  if RUBY_PLATFORM == 'i386-mingw32'
-    `where origen`.split("\n").find do |match|
-      match =~ /(.*)\\bin\\origen$/
-    end
-    origen_top = $1.gsub("\\", "/")
-  else
-    origen_top = `which origen`.strip.sub("/bin/origen", "")
-  end
-
-  $LOAD_PATH.unshift "#{origen_top}/lib"
-end
-
-require "origen"
-
-require "rspec/legacy_formatters"
-require "#{Origen.top}/spec/format/origen_formatter"
-
-if RUBY_VERSION >= '2.0.0'
-  require "byebug"
-else
-  require 'debugger'
-end
+require "byebug"
 require 'pry'
 
 def load_target(target="default")

data/templates/app_generators/application/target/default.rb

@@ -0,0 +1 @@
+# Use this file to instantiate the device model you are targeting

data/templates/app_generators/application/target/production.rb

@@ -1,9 +1,4 @@
 # The target file is run before *every* Origen operation and is used to instantiate
 # the runtime environment - usually this means instantiating a top-level SoC or
 # IP model.
-#
-# Naming is arbitrary but instances names should be prefixed with $ which indicates a 
-# global variable in Ruby, and this is required in order for the objects instantiated
-# here to be visible throughout your application code.
-
-$dut = <%= @namespace %>::TopLevel.new   # Instantiate a DUT instance
+<%= @namespace %>::TopLevel.new   # Instantiate a DUT instance

data/templates/app_generators/plugin/Gemfile

@@ -6,15 +6,10 @@ source '<%= Origen.site_config.gem_server %>'
 # Specify your gem's dependencies in <%= @name %>.gemspec
 gemspec
 
+# Only these gems should be added here
 <% if @audience == :external -%>
 # This gem provides integration with https://coveralls.io/ to monitor
 # your application's test coverage
 gem 'coveralls', require: false
 <% end -%>
-
-# Only these gems should be added here
-if RUBY_VERSION >= '2.0.0'
-  gem 'byebug', '~>3.5'
-else
-  gem 'debugger', '~>1.6'
-end
+gem 'byebug', '~>3.5'

data/templates/app_generators/plugin/Rakefile

@@ -1,5 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/app_tasks.rake, and they will automatically be available to Rake.
+# for example lib/tasks/<%= @name %>.rake, and they will automatically
+# be available to Rake.
 #
 # Any task files found in lib/tasks/shared/*.rake will be made available to 3rd party
 # apps that use this plugin

data/templates/app_generators/plugin/gemspec.rb

@@ -8,9 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ["<%= User.current.name %>"]
   spec.email         = ["<%= User.current.email %>"]
   spec.summary       = "<%= @summary %>"
-  spec.homepage      = "http://origen.freescale.net/<%= @name %>"
+<% if @audience == :external -%>
+  #spec.homepage      = "http://origen-sdk.org/<%= @name %>"
+<% else -%>
+  #spec.homepage      = "http://origen.mycompany.net/<%= @name %>"
+<% end -%>
 
-  spec.required_ruby_version     = '>= 1.9.3'
+  spec.required_ruby_version     = '>= 2'
   spec.required_rubygems_version = '>= 1.8.11'
 
   # Only the files that are hit by these wildcards will be included in the
@@ -32,5 +36,5 @@ Gem::Specification.new do |spec|
 <% end -%>
 
   # Add any gems that your plugin needs for its development environment only
-  #spec.add_development_dependency "doc_helpers", ">= 1.7.0"
+  spec.add_development_dependency "origen_doc_helpers"
 end

data/templates/app_generators/test_engineering/stand_alone_application/environment/j750.rb

@@ -1 +1 @@
-$tester = OrigenTesters::J750.new
+OrigenTesters::J750.new

data/templates/app_generators/test_engineering/stand_alone_application/environment/jlink.rb

@@ -1 +1 @@
-$tester = OrigenDebuggers::JLink.new
+OrigenDebuggers::JLink.new

data/templates/app_generators/test_engineering/stand_alone_application/environment/uflex.rb

@@ -1 +1 @@
-$tester = OrigenTesters::UltraFLEX.new
+OrigenTesters::UltraFLEX.new

data/templates/app_generators/test_engineering/stand_alone_application/environment/v93k.rb

@@ -1 +1 @@
-$tester = OrigenTesters::V93K.new
+OrigenTesters::V93K.new

data/templates/app_generators/test_engineering/stand_alone_application/lib/ip_block.rb

@@ -13,9 +13,9 @@ module <%= @namespace %>
     def instantiate_sub_blocks(options = {})
 <% @options[:sub_blocks].each do |name, attrs| -%>
 <%   if attrs[:instances] -%>
-      sub_blocks :<%= name.underscore %>, instances: <%= attrs[:instances] %>, class_name: '<%= name.camelize %>'
+      sub_block :<%= name.underscore %>, instances: <%= attrs[:instances] %>, class_name: '<%= name.camelize %>'
 <%   else -%>
-      sub_block  :<%= name.underscore %>, class_name: '<%= name.camelize %>'
+      sub_block :<%= name.underscore %>, class_name: '<%= name.camelize %>'
 <%   end -%>
 <% end -%>
     end

data/templates/app_generators/test_engineering/stand_alone_application/lib/top_level.rb

@@ -1,5 +1,5 @@
 module <%= @namespace %>
-  class <%= @options[:name] || "TopLevel" %>
+  class <%= @options[:name] || 'TopLevel' %>
     include Origen::TopLevel
 
     def initialize(options = {})
@@ -23,9 +23,9 @@ module <%= @namespace %>
     def instantiate_sub_blocks(options = {})
 <% @options[:sub_blocks].each do |name, attrs| -%>
 <%   if attrs[:instances] -%>
-      sub_blocks :<%= name.underscore %>, instances: <%= attrs[:instances] %>, class_name: '<%= name.camelize %>'
+      sub_block :<%= name.underscore %>, instances: <%= attrs[:instances] %>, class_name: '<%= name.camelize %>'
 <%   else -%>
-      sub_block  :<%= name.underscore %>, class_name: '<%= name.camelize %>'
+      sub_block :<%= name.underscore %>, class_name: '<%= name.camelize %>'
 <%   end -%>
 <% end -%>
     end

data/templates/app_generators/test_engineering/stand_alone_application/lib/top_level_controller.rb

@@ -1,18 +1,18 @@
 module <%= @namespace %>
-  class <%= @options[:name] || "TopLevel" %>Controller
+  class <%= @options[:name] || 'TopLevel' %>Controller
     include Origen::Controller
 
     def startup(options)
-      pp "Enter test mode" do
-        $tester.set_timeset("func_25mhz", 40)   # Where 40 is the period in ns
+      pp 'Enter test mode' do
+        tester.set_timeset('func_25mhz', 40)   # Where 40 is the period in ns
         pin(:tclk).drive!(1)
         pin(:resetb).drive!(1)
-        $tester.wait time_in_us: 100
+        tester.wait time_in_us: 100
       end
     end
 
     def shutdown(options)
-      pp "Reset the device" do
+      pp 'Reset the device' do
         pin(:resetb).drive!(0)
         pin(:tclk).drive!(0)
       end

data/templates/app_generators/test_engineering/stand_alone_application/target/top_level.rb

@@ -1,8 +1,4 @@
 # The target file is run before *every* Origen operation and is used to instantiate
 # the runtime environment - usually this means instantiating a top-level SoC or
 # IP model.
-#
-# Naming is arbitrary but instances names should be prefixed with $ which indicates a 
-# global variable in Ruby, and this is required in order for the objects instantiated
-# here to be visible throughout your application code.
-$dut = <%= @namespace %>::<%= @options[:name] || "TopLevel" %>.new   # Instantiate a DUT instance
+<%= @namespace %>::<%= @options[:name] || "TopLevel" %>.new   # Instantiate a DUT instance

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_app_generators
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -39,8 +39,8 @@ files:
 - lib/origen_app_generators.rb
 - lib/origen_app_generators/application.rb
 - lib/origen_app_generators/base.rb
-- lib/origen_app_generators/generic_application.rb
-- lib/origen_app_generators/generic_plugin.rb
+- lib/origen_app_generators/empty_application.rb
+- lib/origen_app_generators/empty_plugin.rb
 - lib/origen_app_generators/new.rb
 - lib/origen_app_generators/plugin.rb
 - lib/origen_app_generators/sub_block_parser.rb
@@ -48,6 +48,7 @@ files:
 - lib/origen_app_generators/test_engineering/test_block.rb
 - lib/tasks/app_generators.rake
 - lib/tasks/boot.rb
+- lib/tasks/new_app_tests.rake
 - templates/app_generators/application/Gemfile
 - templates/app_generators/application/Rakefile
 - templates/app_generators/application/config/application.rb
@@ -61,6 +62,7 @@ files:
 - templates/app_generators/application/origen_core_session
 - templates/app_generators/application/spec/spec_helper.rb
 - templates/app_generators/application/target/debug.rb
+- templates/app_generators/application/target/default.rb
 - templates/app_generators/application/target/production.rb
 - templates/app_generators/new/generator.rb
 - templates/app_generators/new/info.md.erb