origen_app_generators 1.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3eeb6b201324eb47d17666280a9d5235933d32fd
-  data.tar.gz: 434f5ed2879e524353e286edf88843a2db290c55
+SHA256:
+  metadata.gz: 64a1039908eba30b3a33e2da0d8696af09c414f91a7a42cea5aa90982586129b
+  data.tar.gz: fab5ecfe17f9cf65c765c651b8447081ad9081c5b04c60511dcfabbad200a4e8
 SHA512:
-  metadata.gz: bf475ec0c8e8049b2e332185d384306327c3bd2d9973fb2baa915e2e5a0f8981b0829de581e9f3f1c4d46169d41c6e217983904d13dfc4d1c5a049db7093507b
-  data.tar.gz: e570d4f5f11f014b7dd105d3dbadd0ab301e1d1406fba86a8d93f23ef2d11bfd35263e703cf901fb95f1f2d4efa73d188b3ebfdd5ef78d8171ff670f1d24c442
+  metadata.gz: 2f7a4bf3e601713cade91fffd45e866f4c9e66fbd0554afbf222e303d6efa9d12f65f9a9574f7f766657c8cf5dacc3e7de5bc4b910533d92be679fef07402322
+  data.tar.gz: 29c49bae93ea8ef4970d06f5f3bf9ed98304b8e24ada166a5136049a93609e4bf229c53bb18c40aaa2e95ab2498d71e70b15e4759525d0328d6ab6e2c4f7d9bb

data/bin/boot.rb

@@ -30,8 +30,10 @@ begin
     OrigenAppGenerators.unload_generators unless ARGV[0]
     require load_generators if File.exist?(load_generators)
 
-    OrigenAppGenerators.invoke('tmp')
+    OrigenAppGenerators.invoke('my_app')
   end
 ensure
-  FileUtils.mv "#{tmp_dir}/tmp", 'tmp' if File.exist?("#{tmp_dir}/tmp")
+  FileUtils.mv "#{tmp_dir}/my_app", 'output' if File.exist?("#{tmp_dir}/my_app")
+  puts
+  puts "Ignore the above, your new app is in: output/my_app"
 end

data/config/commands.rb

@@ -56,8 +56,8 @@ when "specs"
 ## 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
-  EOT
+#  @application_commands = <<-EOT
+# specs        Run the specs (tests), -c will enable coverage
+#  EOT
 
 end 

data/config/shared_commands.rb

@@ -7,9 +7,11 @@ when "app_gen:test"
   opt_parser = OptionParser.new do |opts|
     opts.banner = <<-END
 Test the generators by emulating the 'origen new' command execution and building the new
-application into the tmp directory.
+application into the output/my_app directory.
 
 Usage: origen app_gen:test [options]
+       origen app_gen:test --regression             # Test all generators
+       origen app_gen:test --inputs 0               # Test with user inputs set 0
 END
     opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
     opts.on('-i', '--inputs INDEX', Integer, "Apply the set of test inputs defined in #{Origen.app.namespace}::TEST_INPUTS[INDEX]") { |f| options[:inputs] = f }
@@ -21,7 +23,9 @@ END
 
   opt_parser.orig_parse! ARGV
 
-  FileUtils.rm_rf "#{Origen.root}/tmp" if File.exist?("#{Origen.root}/tmp")
+  output_dir = File.join(Origen.root, 'output')
+  FileUtils.rm_rf output_dir if File.exist?(output_dir)
+  FileUtils.mkdir_p output_dir
 
   if options[:inputs] || options[:regression]
     if options[:regression]
@@ -41,14 +45,16 @@ END
       post_build_operations = post_build_operations.map do |op|
         if op.to_s == 'default'
           target_load_test_required = true
-          ['origen -v',
-           'origen lint --no-correct',
-           'bundle exec rake new_app_tests:load_target',
-           'origen web compile --no-serve'
-          ]
+          cmds = ['origen -v']
+          # For some reason this command doesn't work in Travis CI, don't know why and
+          # couldn't work out how to fix (looks like a Bundler-related issue)
+          cmds << 'origen lint --no-correct' unless ENV['TRAVIS']
+          cmds << 'bundle exec origen exec tmp/new_app_tests.rb'
+          cmds << 'origen web compile --no-serve'
+          cmds
         elsif op.to_s == 'load_target'
           target_load_test_required = true
-          'rake new_app_tests:load_target'
+          'origen exec tmp/new_app_tests.rb'
         else
           op
         end
@@ -67,12 +73,13 @@ END
         # The app is successfully built, now see if it works...
         unless post_build_operations.empty?
           if target_load_test_required
-            FileUtils.cp "#{Origen.root!}/lib/tasks/new_app_tests.rake", 'tmp/lib/tasks'
+            FileUtils.mkdir_p('output/my_app/tmp')
+            FileUtils.cp "#{Origen.root!}/lib/origen_app_generators/new_app_tests.rb", 'output/my_app/tmp'
           end
 
           operation_failed = false
           Bundler.with_clean_env do
-            Dir.chdir "#{Origen.root}/tmp" do
+            Dir.chdir "#{Origen.root}/output/my_app" do
               post_build_operations.each_with_index do |op, i|
                 if i == 0 && !Origen.site_config.gem_manage_bundler
                   system('bundle')

data/config/version.rb

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

data/lib/origen_app_generators.rb

@@ -7,6 +7,7 @@ require 'origen_app_generators/plugin'
 require 'origen_app_generators/empty_application'
 require 'origen_app_generators/empty_plugin'
 require 'origen_app_generators/new'
+require 'origen_app_generators/test_engineering/common'
 require 'origen_app_generators/test_engineering/test_block'
 require 'origen_app_generators/test_engineering/stand_alone_application'
 require 'origen_app_generators/origen_infrastructure/app_generator_plugin'
@@ -16,15 +17,16 @@ module OrigenAppGenerators
 
   TEST_INPUTS = [
     # 0 - Empty app
-    ['0', '0', :default, :default, :default],
+    ['0', '0', :default],
     # 1 - Empty plugin
     ['0', '1', :default, :default, 'A test block', 'yes', :default],
     # 2 - Stand alone test engineering app
-    ['2', '0', :default, :default, 'Falcon, Eagle', 'Falcon[ram, atd(2), comm[ram(2), osc](3)], Eagle[ram(2), atd(4)]', [:default, 'origen g example']],
+    ['2', '0', [:default]],
     # 3 - Test module
-    ['2', '1', :default, :default, 'Test module for all flash IPs', 'FLASH_512K, FLASH_1024K', 'flash', [:default, 'origen g example']],
+    # ['2', '1', 'Test module for all flash IPs', [:default, 'origen g example']],
+    ['2', '1', 'Test module for all flash IPs', :default],
     # 4 - An app generators plugin
-    ['1', '0', :default, :default, 'My application generators', :default]
+    ['1', '0', 'My application generators', :default]
   ] # END_OF_TEST_INPUTS Don't remove this comment, it is used by the app_gen:new command!
 
   # As you add new generators to this app they will be entered here, this enables the

data/lib/origen_app_generators/application.rb

@@ -33,19 +33,19 @@ module OrigenAppGenerators
         config_prod:        { source: 'config/maillist_prod.txt' },
         doc_history:        { source: 'doc/history' },
         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 },
+        # 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_tasks:          { source: 'lib/app.rake',
-                              dest:   "lib/tasks/#{@name}.rake" },
+        lib_module:         { source: 'app/lib/module.rb',
+                              dest:   "app/lib/#{@name}.rb" },
+        lib_module_dir:     { dest:   "app/lib/#{@name}", type: :directory },
+        app_blocks_dir:     { dest:   'app/blocks', type: :directory },
         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_navbar:         { source: 'templates/web/partials/_navbar.html.erb' },
-        web_release_notes:  { source: 'templates/web/release_notes.md.erb' },
+        web_index:          { source: 'app/templates/web/index.md.erb' },
+        web_basic_layout:   { source: 'app/templates/web/layouts/_basic.html.erb' },
+        web_navbar:         { source: 'app/templates/web/partials/_navbar.html.erb' },
+        web_release_notes:  { source: 'app/templates/web/release_notes.md.erb' },
         rakefile:           { source: 'Rakefile' },
         gemfile:            { source: 'Gemfile' },
         gitignore:          { source: '.gitignore' },
@@ -55,7 +55,7 @@ module OrigenAppGenerators
         session:            { source: 'origen_core_session',
                               dest:   '.session/origen_core',
                               copy:   true
-                            }
+                             }
       }
     end
   end

data/lib/origen_app_generators/base.rb

@@ -5,6 +5,21 @@ module OrigenAppGenerators
 
     require 'gems'
 
+    def validate_application_name
+      @name = args.first.to_s.strip
+      if @name == ''
+        puts
+        puts "You must supply a name for what you want to call your application: 'origen new my_name'"
+        puts
+        exit 1
+      elsif @name != @name.symbolize.to_s
+        puts
+        puts 'The name of your new app must be lowercased and underscored and contain no special characters'
+        puts
+        exit 1
+      end
+    end
+
     def set_source_paths
       # The base Origen generator puts the Origen core directory on the source path, in retrospect this
       # was a bad idea and makes for hard to debug errors if an app generator resolves a template from
@@ -25,7 +40,11 @@ module OrigenAppGenerators
           dir << "#{template_dir}/base"
           klass = last_class
         else
-          dir = "#{Origen.root!}/templates/app_generators/#{class_dir(klass)}"
+          dir = []
+          class_dirs(klass).each do |class_dir|
+            dir << "#{Origen.root!}/templates/app_generators/#{class_dir}"
+            dir << "#{Origen.root!}/app/templates/app_generators/#{class_dir}"
+          end
         end
         Array(dir).each do |dir|
           self.class.source_paths << dir if File.exist?(dir) && !self.class.source_paths.include?(dir)
@@ -40,11 +59,31 @@ module OrigenAppGenerators
     end
 
     def get_common_user_input
-      get_name_and_namespace
+      # Don't bother asking the user for this, their life will be easier if they just go with
+      # Origen's default namespace based on their app's name
+      @namespace = @name.to_s.camelize
     end
 
     def get_lastest_origen_version
-      @latest_origen_version = (Gems.info 'origen')['version']
+      @latest_origen_version ||= begin
+        (Gems.info 'origen')['version']
+      rescue
+        # If the above fails, e.g. due to an SSL error in the runtime environment, try to fetch the
+        # latest Origen version from the Origen website, before finally falling back to the version
+        # we are currently running if all else fails
+        begin
+          require 'httparty'
+          response = HTTParty.get('http://origen-sdk.org/origen/release_notes/')
+          version = Origen::VersionString.new(response.body.match(/Tag: v(\d+\.\d+.\d+)</).to_a.last)
+          if version.valid?
+            version
+          else
+            fail "Can't get the latest version!"
+          end
+        rescue
+          Origen.version
+        end
+      end
     end
 
     protected
@@ -55,6 +94,17 @@ module OrigenAppGenerators
       names.map(&:underscore).join('/')
     end
 
+    def class_dirs(klass)
+      names = klass.to_s.split('::')
+      names.shift
+      dirs = []
+      until names.empty?
+        dirs << names.map(&:underscore).join('/')
+        names.pop
+      end
+      dirs
+    end
+
     # def application_class?(klass)
     #  until klass == OrigenAppGenerators::Base
     # end
@@ -115,12 +165,6 @@ module OrigenAppGenerators
       symlink_cmds.each { |cmd| system(cmd) }
     end
 
-    # Convenience method that is equivalent to calling get_name and then get_namespace
-    def get_name_and_namespace
-      get_name
-      get_namespace
-    end
-
     # Prompts the user to confirm or enter the Ruby namespace to be used in the app.
     #
     # If @name is already defined a proposal will be generated from that, alternatively a proposal

data/lib/origen_app_generators/new.rb

@@ -28,13 +28,13 @@ module OrigenAppGenerators
 
       # **** Add require line ****
       module_declaration = /\nmodule #{Origen.app.namespace}/
-      inject_into_file "lib/#{Origen.app.name}.rb", "require '#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}'\n",
+      inject_into_file "#{app_dir}lib/#{Origen.app.name}.rb", "require '#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}'\n",
                        before: module_declaration
 
       # **** Add to the AVAILABLE hash ****
       if available[@domain_summary]
         existing_domain = /\s*('|")#{@domain_summary}('|") => \[\s*\n/
-        inject_into_file "lib/#{Origen.app.name}.rb", "      #{Origen.app.namespace}::#{@domain_namespace}::#{@classname},\n",
+        inject_into_file "#{app_dir}lib/#{Origen.app.name}.rb", "      #{Origen.app.namespace}::#{@domain_namespace}::#{@classname},\n",
                          after: existing_domain
       else
         new_domain = <<-END
@@ -43,7 +43,7 @@ module OrigenAppGenerators
     ],
         END
         available_hash = /AVAILABLE = {\s*\n/
-        inject_into_file "lib/#{Origen.app.name}.rb", new_domain, after: available_hash
+        inject_into_file "#{app_dir}lib/#{Origen.app.name}.rb", new_domain, after: available_hash
       end
 
       # **** Add a starter set of test inputs ****
@@ -59,11 +59,11 @@ module OrigenAppGenerators
       if @parentclass == 'Plugin'
         inputs += "    ['#{first}', '#{second}', :default, :default, 'A cool plugin', 'yes', :default]"
       else
-        inputs += "    ['#{first}', '#{second}', :default, :default, :default]"
+        inputs += "    ['#{first}', '#{second}', :default]"
       end
       inputs = ",#{inputs}" unless test_inputs.empty?
       end_of_test_inputs = /\n\s*\]\s*#\s*END_OF_TEST_INPUTS/
-      inject_into_file "lib/#{Origen.app.name}.rb", inputs, before: end_of_test_inputs
+      inject_into_file "#{app_dir}lib/#{Origen.app.name}.rb", inputs, before: end_of_test_inputs
     end
 
     # Can't compile this as contains some final ERB, so substitute instead
@@ -78,7 +78,7 @@ module OrigenAppGenerators
     # end
 
     def conclude
-      system "origen lint #{Origen.root}/lib/#{Origen.app.name}.rb"
+      system "origen lint #{Origen.root}/#{app_dir}lib/#{Origen.app.name}.rb"
       puts
       puts "New generator created at: #{filelist[:generator][:dest]}"
       puts
@@ -90,6 +90,14 @@ module OrigenAppGenerators
 
     protected
 
+    def app_dir
+      if File.exist?("#{Origen.root}/app/lib")
+        'app/'
+      else
+        ''
+      end
+    end
+
     def get_summary
       puts
       puts 'DESCRIBE YOUR NEW GENERATOR IN A FEW WORDS'
@@ -151,11 +159,11 @@ module OrigenAppGenerators
     def filelist
       @filelist ||= {
         generator:     { source: 'generator.rb',
-                         dest:   "lib/#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}.rb" },
-        templates_dir: { dest: "templates/app_generators/#{@domain_namespace.underscore}/#{@classname.underscore}",
+                         dest:   "#{app_dir}lib/#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}.rb" },
+        templates_dir: { dest: "#{app_dir}templates/app_generators/#{@domain_namespace.underscore}/#{@classname.underscore}",
                          type: :directory },
         # doc_info:      { source: 'info.md.erb',
-        #                 dest:   "templates/web/#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}.md.erb" }
+        #                 dest:   "#{app_dir}templates/web/#{Origen.app.name}/#{@domain_namespace.underscore}/#{@classname.underscore}.md.erb" }
       }
     end
   end

data/lib/{tasks/new_app_tests.rake → origen_app_generators/new_app_tests.rb}

@@ -1,8 +1,4 @@
 # This file has been added by origen_app_generators to test that the target can be
 # loaded within this application, it will not be included in your final application
 # builds once your generator has been released.
-namespace :new_app_tests do
-  task :load_target do
-    Origen.app.target.load!
-  end
-end
+Origen.app.target.load!

data/lib/origen_app_generators/origen_infrastructure/app_generator_plugin.rb

@@ -77,23 +77,21 @@ module OrigenAppGenerators
           list = super  # Always pick up the parent list
           # Example of how to remove a file from the parent list
           # list.delete(:web_doc_layout)
-          list.delete(:lib_readme)
-          list.delete(:lib_readme_dev)
           list.delete(:templates_shared)
           # 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
           # list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
           list[:config_load_generators] = { source: 'config/load_generators.rb' }
-          list[:lib_base] = { source: 'lib/base.rb', dest: "lib/#{@name}/base.rb" }
-          list[:lib_plugin] = { source: 'lib/plugin.rb', dest: "lib/#{@name}/plugin.rb" }
-          list[:lib_application] = { source: 'lib/application.rb', dest: "lib/#{@name}/application.rb" }
+          list[:lib_base] = { source: 'app/lib/base.rb', dest: "app/lib/#{@name}/base.rb" }
+          list[:lib_plugin] = { source: 'app/lib/plugin.rb', dest: "app/lib/#{@name}/plugin.rb" }
+          list[:lib_application] = { source: 'app/lib/application.rb', dest: "app/lib/#{@name}/application.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[:templates_app] = { dest: 'templates/app_generators/application', type: :directory }
-          list[:templates_plugin] = { dest: 'templates/app_generators/plugin', type: :directory }
-          list[:templates_base] = { dest: 'templates/app_generators/base', type: :directory }
+          list[:templates_app] = { dest: 'app/templates/app_generators/application', type: :directory }
+          list[:templates_plugin] = { dest: 'app/templates/app_generators/plugin', type: :directory }
+          list[:templates_base] = { dest: 'app/templates/app_generators/base', type: :directory }
           # By default, directories created in this way will contain a .keep file, to inhibit this:
           # list[:pattern_dir] = { dest: "pattern", type: :directory, nokeep: true }
           # Example of how to create a symlink

data/lib/origen_app_generators/plugin.rb

@@ -1,8 +1,7 @@
 module OrigenAppGenerators
   # The base generator class that should be used by all plugin generators
   class Plugin < Application
-    def get_common_user_input
-      get_name_and_namespace
+    def get_additional_user_input
       get_summary
       get_audience unless @audience
     end
@@ -19,15 +18,13 @@ module OrigenAppGenerators
         list.delete(:web_installation)
         list.delete(:web_introduction)
         list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
-        list[:templates_shared] = { dest: 'templates/shared', type: :directory }
+        list[:templates_shared] = { dest: 'app/templates/shared', type: :directory }
         if @audience == :external
           list[:travis] = { source: '.travis.yml' }
-          list[:web_navbar] = { source: 'templates/web/partials/_navbar_external.html.erb', dest: 'templates/web/partials/_navbar.html.erb' }
+          list[:web_navbar] = { source: 'app/templates/web/partials/_navbar_external.html.erb', dest: 'app/templates/web/partials/_navbar.html.erb' }
         else
-          list[:web_navbar] = { source: 'templates/web/partials/_navbar_internal.html.erb', dest: 'templates/web/partials/_navbar.html.erb' }
+          list[:web_navbar] = { source: 'app/templates/web/partials/_navbar_internal.html.erb', dest: 'app/templates/web/partials/_navbar.html.erb' }
         end
-        list[:lib_readme] = { source: 'lib/README', dest: "lib/#{@name}/README" }
-        list[:lib_readme_dev] = { source: 'lib_dev/README', dest: "lib/#{@name}_dev/README" }
         list
       end
     end

data/lib/origen_app_generators/test_engineering/common.rb

@@ -0,0 +1,29 @@
+module OrigenAppGenerators
+  module TestEngineering
+    module Common
+      def common_filelist(list)
+        # Example of how to remove a file from the parent list
+        # list.delete(:target_debug)
+        # 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
+        list[:environment_v93k] = { source: 'environment/v93k.rb' }
+        list[:environment_j750] = { source: 'environment/j750.rb' }
+        list[:environment_uflex] = { source: 'environment/uflex.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: 'uflex.rb',           # Relative to the file being linked to
+                                       dest:   'environment/default.rb', # Relative to destination_root
+                                       type:   :symlink }
+        # Test engineering source directories
+        list[:patterns_dir] = { dest: 'app/patterns', type: :directory }
+        list[:flows_dir]    = { dest: 'app/flows', type: :directory }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end