origen_app_generators 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efe3f54f85b5eb4fbf72aa62d4735d1b3eb91a0d
-  data.tar.gz: a7ac8e0632d178b7549e39fdb1c2b7da8c9a0bd5
+  metadata.gz: 52ed0cc091ddc22553ff9ef23b89d32a583f5dad
+  data.tar.gz: 15d517d2d9057b35ce8b10ced794abc241de6332
 SHA512:
-  metadata.gz: b5234f29caa0c4f6611ec22b79cfa3cca7714104b6487ae22f0fa8dc222349c992238df591856d630c1d984e5f80d7e2579d1dd59900c830720dd974be0929ae
-  data.tar.gz: f26c931c0aec81bdc5f8125db023736e105e37eb5f21d70352b2022aa30a58ea23f36b302d938a1f15d8f22d231e85c58764e22fce31c8303dde9286d4e53f20
+  metadata.gz: 30fb76df25db734b690c4669a79b6bd124e454d97b909daf48fa6811cc7d90800971b4310a8bed202d3d060ffc145eec5bf311c052926815e287c15c8a19814f
+  data.tar.gz: 35c4fed01e48500f0823a62c29387cdd429b0f9261a68c24829c16f0566853c601a39203580d19b7220a21e7c0a1a36cd04168b7e259e3a921aebf2c213b1a15

data/config/version.rb

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

data/lib/origen_app_generators/base.rb

@@ -14,15 +14,22 @@ module OrigenAppGenerators
       klass = self.class
 
       until klass == OrigenAppGenerators::Base
-        names = klass.to_s.split('::')
-        names.shift
-        dir = names.map(&:underscore).join('/')
-        if OrigenAppGenerators.template_dirs[klass]
-          dir = File.expand_path("#{OrigenAppGenerators.template_dirs[klass]}/#{dir}", __FILE__)
+        if template_dir = OrigenAppGenerators.template_dirs[klass]
+          dir = []
+          last_class = nil
+          until klass.to_s =~ /^OrigenAppGenerators/
+            dir << "#{template_dir}/#{class_dir(klass)}"
+            last_class = klass
+            klass = klass.superclass
+          end
+          dir << "#{template_dir}/base"
+          klass = last_class
         else
-          dir = File.expand_path("#{Origen.root!}/templates/app_generators/#{dir}", __FILE__)
+          dir = "#{Origen.root!}/templates/app_generators/#{class_dir(klass)}"
+        end
+        Array(dir).each do |dir|
+          self.class.source_paths << dir if File.exist?(dir) && !self.class.source_paths.include?(dir)
         end
-        self.class.source_paths << dir if File.exist?(dir) && !self.class.source_paths.include?(dir)
         klass = klass.superclass
       end
     end
@@ -42,6 +49,16 @@ module OrigenAppGenerators
 
     protected
 
+    def class_dir(klass)
+      names = klass.to_s.split('::')
+      names.shift
+      names.map(&:underscore).join('/')
+    end
+
+    # def application_class?(klass)
+    #  until klass == OrigenAppGenerators::Base
+    # end
+
     def debugger
       require 'byebug'
       byebug # rubocop:disable Lint/Debugger
@@ -74,7 +91,11 @@ module OrigenAppGenerators
             create_link file[:dest], file[:source]
           end
         elsif file[:type] == :dir || file[:type] == :directory
-          empty_directory(file[:dest] || file[:source])
+          if file[:nokeep]
+            empty_directory(file[:dest] || file[:source])
+          else
+            copy_file('dot_keep', "#{file[:dest]}/.keep")
+          end
         else
           dest = file[:dest] || file[:source]
           if file[:copy] || dest =~ /.erb$/

data/lib/origen_app_generators/new.rb

@@ -62,7 +62,7 @@ module OrigenAppGenerators
         inputs += "    ['#{first}', '#{second}', :default, :default, :default]"
       end
       inputs = ",#{inputs}" unless test_inputs.empty?
-      end_of_test_inputs = /\n\s*]\s*#\s*END_OF_TEST_INPUTS/
+      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
     end
 

data/lib/origen_app_generators/origen_infrastructure/app_generator_plugin.rb

@@ -79,17 +79,23 @@ module OrigenAppGenerators
           # 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" }
           # 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 }
+          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 }
+          # 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
           # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
           #                          dest:   'target/default.rb', # Relative to destination_root

data/templates/app_generators/new/generator.rb

@@ -86,6 +86,8 @@ module <%= @namespace %>
           # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
           # Example of how to create a directory
           # list[:pattern_dir] = { dest: "pattern", 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
           # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
           #                           dest:   'target/default.rb', # Relative to destination_root

data/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/application.rb

@@ -2,6 +2,8 @@ module <%= @namespace %>
   # This will be the parent class of all of your application generators, it provides a place
   # to add anything that you want to be added to all of your applications
   class Application < OrigenAppGenerators::Application
+    include Base
+
     # Any methods added above the protected line will get automatically invoked
     # at the start of *all* of your application generators.
 
@@ -36,6 +38,8 @@ module <%= @namespace %>
         # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
         # Example of how to create a directory
         # list[:pattern_dir] = { dest: "pattern", 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
         # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
         #                           dest:   'target/default.rb', # Relative to destination_root

data/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/base.rb

@@ -0,0 +1,53 @@
+module <%= @namespace %>
+  # This is a mixin that is included in both the application and plugin
+  # generators, it provides a place to add things that should apply to
+  # all of your applications and plugins
+  module Base
+    # Any helper methods added to this base module will not be automatically invoked,
+    # you must call them from either the top-level application or plugin generators,
+    # or from a child generator.
+
+    protected
+
+    # Here you can modify the default list of files that are included in all of your
+    # applications AND plugins.
+    #
+    # See here for the default list of files:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    # If the child generator is a plugin, then this list is then modified by the base plugin generator which
+    # you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new application.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generators, this means that your generator will automatically stay up
+    # to date with the latest conventions.
+    #
+    # Additional files can be added or removed from the filelist as shown below.
+    def filelist
+      @filelist ||= begin
+        list = super  # Always pick up the parent list
+        # Example of how to remove a file from the parent list
+        # list.delete(:web_doc_layout)
+        # 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' }
+        # 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 }
+        # 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
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                           dest:   'target/default.rb', # Relative to destination_root
+        #                           type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/module.rb

@@ -1,4 +1,5 @@
 require 'origen_app_generators'
+require '<%= @name %>/base'
 require '<%= @name %>/application'
 require '<%= @name %>/plugin'
 

data/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/plugin.rb

@@ -2,6 +2,8 @@ module <%= @namespace %>
   # This will be the parent class of all of your plugin generators, it provides a place
   # to add anything that you want to be added to all of your plugins
   class Plugin < OrigenAppGenerators::Plugin
+    include Base
+
     def initialize(*args)
       # This makes all of your plugins be configured for internal distribution, i.e. rather
       # than via rubygems.org
@@ -19,7 +21,7 @@ module <%= @namespace %>
 
     # Here you can modify the default list of files that are included in all of your plugins.
     #
-    # Since this is a plugin genrator, the default list of files comprises the application list,
+    # Since this is a plugin generator, the default list of files comprises the application list,
     # which you can see here:
     # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
     # And this is then modified by the base plugin generator which you can see here:
@@ -46,6 +48,8 @@ module <%= @namespace %>
         # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
         # Example of how to create a directory
         # list[:pattern_dir] = { dest: "pattern", 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
         # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
         #                          dest:   'target/default.rb', # Relative to destination_root

data/templates/app_generators/plugin/Gemfile

@@ -10,7 +10,7 @@ source '<%= Origen.site_config.gem_server %>'
 # your application's test coverage
 gem 'coveralls', require: false
 <% end -%>
-gem 'byebug'
+gem 'byebug', '<9.1.0' # This version restriction required if you need Ruby < 2.2, otherwise you can remove it
 gem 'ripper-tags'
 gem 'origen_doc_helpers'
 gem 'origen_updater'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_app_generators
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
 description: 
 email:
 - stephen.f.mcginty@gmail.com
@@ -64,6 +64,7 @@ files:
 - templates/app_generators/application/config/maillist_prod.txt
 - templates/app_generators/application/config/version.rb
 - templates/app_generators/application/doc/history
+- templates/app_generators/application/dot_keep
 - templates/app_generators/application/lib/app.rake
 - templates/app_generators/application/lib/module.rb
 - templates/app_generators/application/lib/top_level.rb
@@ -80,6 +81,7 @@ files:
 - templates/app_generators/new/info.md.erb
 - templates/app_generators/origen_infrastructure/app_generator_plugin/config/load_generators.rb
 - templates/app_generators/origen_infrastructure/app_generator_plugin/lib/application.rb
+- templates/app_generators/origen_infrastructure/app_generator_plugin/lib/base.rb
 - templates/app_generators/origen_infrastructure/app_generator_plugin/lib/module.rb
 - templates/app_generators/origen_infrastructure/app_generator_plugin/lib/plugin.rb
 - templates/app_generators/plugin/Gemfile
@@ -133,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Origen application generators