mirror of
https://github.com/ThrowTheSwitch/Unity.git
synced 2025-06-28 13:26:22 +08:00
refactor generate_module so that it can be called as a class from within Ceedling (much like the test runner generator)
This commit is contained in:
Mark VanderVoord
@ -11,46 +11,8 @@
|
|||||||
require 'rubygems'
|
require 'rubygems'
|
||||||
require 'fileutils'
|
require 'fileutils'
|
||||||
|
|
||||||
HERE = File.expand_path(File.dirname(__FILE__)) + '/'
|
|
||||||
|
|
||||||
#help text when requested
|
|
||||||
HELP_TEXT = [ "\nGENERATE MODULE\n-------- ------",
|
|
||||||
"\nUsage: ruby generate_module [options] module_name",
|
|
||||||
" -i\"include\" sets the path to output headers to 'include' (DEFAULT ../src)",
|
|
||||||
" -s\"../src\" sets the path to output source to '../src' (DEFAULT ../src)",
|
|
||||||
" -t\"C:/test\" sets the path to output source to 'C:/test' (DEFAULT ../test)",
|
|
||||||
" -p\"MCH\" sets the output pattern to MCH.",
|
|
||||||
" dh - driver hardware.",
|
|
||||||
" dih - driver interrupt hardware.",
|
|
||||||
" mch - model conductor hardware.",
|
|
||||||
" mvp - model view presenter.",
|
|
||||||
" src - just a single source module. (DEFAULT)",
|
|
||||||
" -d destroy module instead of creating it.",
|
|
||||||
" -u update subversion too (requires subversion command line)",
|
|
||||||
" -y\"my.yml\" selects a different yaml config file for module generation",
|
|
||||||
"" ].join("\n")
|
|
||||||
|
|
||||||
#Built in patterns
|
|
||||||
PATTERNS = { 'src' => {'' => { :inc => [] } },
|
|
||||||
'dh' => {'Driver' => { :inc => ['%1$sHardware.h'] },
|
|
||||||
'Hardware' => { :inc => [] }
|
|
||||||
},
|
|
||||||
'dih' => {'Driver' => { :inc => ['%1$sHardware.h', '%1$sInterrupt.h'] },
|
|
||||||
'Interrupt'=> { :inc => ['%1$sHardware.h'] },
|
|
||||||
'Hardware' => { :inc => [] }
|
|
||||||
},
|
|
||||||
'mch' => {'Model' => { :inc => [] },
|
|
||||||
'Conductor'=> { :inc => ['%1$sModel.h', '%1$sHardware.h'] },
|
|
||||||
'Hardware' => { :inc => [] }
|
|
||||||
},
|
|
||||||
'mvp' => {'Model' => { :inc => [] },
|
|
||||||
'Presenter'=> { :inc => ['%1$sModel.h', '%1$sView.h'] },
|
|
||||||
'View' => { :inc => [] }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#TEMPLATE_TST
|
#TEMPLATE_TST
|
||||||
TEMPLATE_TST = %q[#include "unity.h"
|
TEMPLATE_TST ||= %q[#include "unity.h"
|
||||||
%2$s#include "%1$s.h"
|
%2$s#include "%1$s.h"
|
||||||
|
|
||||||
void setUp(void)
|
void setUp(void)
|
||||||
@ -68,97 +30,164 @@ void test_%1$s_NeedToImplement(void)
|
|||||||
]
|
]
|
||||||
|
|
||||||
#TEMPLATE_SRC
|
#TEMPLATE_SRC
|
||||||
TEMPLATE_SRC = %q[%2$s#include "%1$s.h"
|
TEMPLATE_SRC ||= %q[%2$s#include "%1$s.h"
|
||||||
]
|
]
|
||||||
|
|
||||||
#TEMPLATE_INC
|
#TEMPLATE_INC
|
||||||
TEMPLATE_INC = %q[#ifndef _%3$s_H
|
TEMPLATE_INC ||= %q[#ifndef _%3$s_H
|
||||||
#define _%3$s_H%2$s
|
#define _%3$s_H%2$s
|
||||||
|
|
||||||
#endif // _%3$s_H
|
#endif // _%3$s_H
|
||||||
]
|
]
|
||||||
|
|
||||||
# Parse the command line parameters.
|
class UnityModuleGenerator
|
||||||
ARGV.each do |arg|
|
|
||||||
case(arg)
|
############################
|
||||||
when /^-d/ then @destroy = true
|
def initialize(options=nil)
|
||||||
when /^-u/ then @update_svn = true
|
|
||||||
when /^-p(\w+)/ then @pattern = $1
|
here = File.expand_path(File.dirname(__FILE__)) + '/'
|
||||||
when /^-s(.+)/ then @path_src = $1
|
|
||||||
when /^-i(.+)/ then @path_inc = $1
|
@options = UnityModuleGenerator.default_options
|
||||||
when /^-t(.+)/ then @path_tst = $1
|
case(options)
|
||||||
when /^-y(.+)/ then @yaml_config = $1
|
when NilClass then @options
|
||||||
when /^(\w+)/
|
when String then @options.merge!(UnityModuleGenerator.grab_config(options))
|
||||||
raise "ERROR: You can't have more than one Module name specified!" unless @module_name.nil?
|
when Hash then @options.merge!(options)
|
||||||
@module_name = arg
|
else raise "If you specify arguments, it should be a filename or a hash of options"
|
||||||
when /^-(h|-help)/
|
|
||||||
puts HELP_TEXT
|
|
||||||
exit
|
|
||||||
else
|
|
||||||
raise "ERROR: Unknown option specified '#{arg}'"
|
|
||||||
end
|
end
|
||||||
end
|
|
||||||
raise "ERROR: You must have a Module name specified! (use option -h for help)" if @module_name.nil?
|
|
||||||
|
|
||||||
#load yaml file if one was requested
|
# Create default file paths if none were provided
|
||||||
if @yaml_config
|
@options[:path_src] = here + "../src/" if @options[:path_src].nil?
|
||||||
|
@options[:path_inc] = @options[:path_src] if @options[:path_inc].nil?
|
||||||
|
@options[:path_tst] = here + "../test/" if @options[:path_tst].nil?
|
||||||
|
@options[:path_src] += '/' unless (@options[:path_src][-1] == 47)
|
||||||
|
@options[:path_inc] += '/' unless (@options[:path_inc][-1] == 47)
|
||||||
|
@options[:path_tst] += '/' unless (@options[:path_tst][-1] == 47)
|
||||||
|
|
||||||
|
#Built in patterns
|
||||||
|
@patterns = { 'src' => {'' => { :inc => [] } },
|
||||||
|
'dh' => {'Driver' => { :inc => ['%1$sHardware.h'] },
|
||||||
|
'Hardware' => { :inc => [] }
|
||||||
|
},
|
||||||
|
'dih' => {'Driver' => { :inc => ['%1$sHardware.h', '%1$sInterrupt.h'] },
|
||||||
|
'Interrupt'=> { :inc => ['%1$sHardware.h'] },
|
||||||
|
'Hardware' => { :inc => [] }
|
||||||
|
},
|
||||||
|
'mch' => {'Model' => { :inc => [] },
|
||||||
|
'Conductor'=> { :inc => ['%1$sModel.h', '%1$sHardware.h'] },
|
||||||
|
'Hardware' => { :inc => [] }
|
||||||
|
},
|
||||||
|
'mvp' => {'Model' => { :inc => [] },
|
||||||
|
'Presenter'=> { :inc => ['%1$sModel.h', '%1$sView.h'] },
|
||||||
|
'View' => { :inc => [] }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
############################
|
||||||
|
def self.default_options
|
||||||
|
{
|
||||||
|
:pattern => "src",
|
||||||
|
:includes =>
|
||||||
|
{
|
||||||
|
:src => [],
|
||||||
|
:inc => [],
|
||||||
|
:tst => [],
|
||||||
|
},
|
||||||
|
:update_svn => false,
|
||||||
|
:boilerplates => {},
|
||||||
|
:test_prefix => 'Test',
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
############################
|
||||||
|
def self.grab_config(config_file)
|
||||||
|
options = self.default_options
|
||||||
|
unless (config_file.nil? or config_file.empty?)
|
||||||
require 'yaml'
|
require 'yaml'
|
||||||
cfg = YAML.load_file(HERE + @yaml_config)[:generate_module]
|
yaml_guts = YAML.load_file(config_file)
|
||||||
@path_src = cfg[:defaults][:path_src] if @path_src.nil?
|
options.merge!(yaml_guts[:unity] || yaml_guts[:cmock])
|
||||||
@path_inc = cfg[:defaults][:path_inc] if @path_inc.nil?
|
raise "No :unity or :cmock section found in #{config_file}" unless options
|
||||||
@path_tst = cfg[:defaults][:path_tst] if @path_tst.nil?
|
end
|
||||||
@update_svn = cfg[:defaults][:update_svn] if @update_svn.nil?
|
return(options)
|
||||||
@extra_inc = cfg[:includes]
|
end
|
||||||
@boilerplates = cfg[:boilerplates]
|
|
||||||
else
|
|
||||||
@boilerplates = {}
|
|
||||||
end
|
|
||||||
|
|
||||||
# Create default file paths if none were provided
|
############################
|
||||||
@path_src = HERE + "../src/" if @path_src.nil?
|
def files_to_operate_on(module_name, pattern=nil)
|
||||||
@path_inc = @path_src if @path_inc.nil?
|
#create triad definition
|
||||||
@path_tst = HERE + "../test/" if @path_tst.nil?
|
prefix = @options[:test_prefix] || 'Test'
|
||||||
@path_src += '/' unless (@path_src[-1] == 47)
|
triad = [ { :ext => '.c', :path => @options[:path_src], :template => TEMPLATE_SRC, :inc => :src, :boilerplate => @options[:boilerplates][:src] },
|
||||||
@path_inc += '/' unless (@path_inc[-1] == 47)
|
{ :ext => '.h', :path => @options[:path_inc], :template => TEMPLATE_INC, :inc => :inc, :boilerplate => @options[:boilerplates][:inc] },
|
||||||
@path_tst += '/' unless (@path_tst[-1] == 47)
|
{ :ext => '.c', :path => @options[:path_tst]+prefix, :template => TEMPLATE_TST, :inc => :tst, :boilerplate => @options[:boilerplates][:tst] },
|
||||||
@pattern = 'src' if @pattern.nil?
|
|
||||||
@includes = { :src => [], :inc => [], :tst => [] }
|
|
||||||
@includes.merge!(@extra_inc) unless @extra_inc.nil?
|
|
||||||
|
|
||||||
#create triad definition
|
|
||||||
TRIAD = [ { :ext => '.c', :path => @path_src, :template => TEMPLATE_SRC, :inc => :src, :boilerplate => @boilerplates[:src] },
|
|
||||||
{ :ext => '.h', :path => @path_inc, :template => TEMPLATE_INC, :inc => :inc, :boilerplate => @boilerplates[:inc] },
|
|
||||||
{ :ext => '.c', :path => @path_tst+'Test', :template => TEMPLATE_TST, :inc => :tst, :boilerplate => @boilerplates[:tst] },
|
|
||||||
]
|
]
|
||||||
|
|
||||||
#prepare the pattern for use
|
#prepare the pattern for use
|
||||||
@patterns = PATTERNS[@pattern.downcase]
|
patterns = @patterns[(pattern || @options[:pattern] || 'src').downcase]
|
||||||
raise "ERROR: The design pattern specified isn't one that I recognize!" if @patterns.nil?
|
raise "ERROR: The design pattern '#{pattern}' specified isn't one that I recognize!" if patterns.nil?
|
||||||
|
|
||||||
# Assemble the path/names of the files we need to work with.
|
# Assemble the path/names of the files we need to work with.
|
||||||
files = []
|
files = []
|
||||||
TRIAD.each do |triad|
|
triad.each do |triad|
|
||||||
@patterns.each_pair do |pattern_file, pattern_traits|
|
patterns.each_pair do |pattern_file, pattern_traits|
|
||||||
|
puts @options.inspect
|
||||||
|
puts pattern_traits.inspect
|
||||||
|
puts module_name.inspect
|
||||||
files << {
|
files << {
|
||||||
:path => "#{triad[:path]}#{@module_name}#{pattern_file}#{triad[:ext]}",
|
:path => "#{triad[:path]}#{module_name}#{pattern_file}#{triad[:ext]}",
|
||||||
:name => "#{@module_name}#{pattern_file}",
|
:name => "#{module_name}#{pattern_file}",
|
||||||
:template => triad[:template],
|
:template => triad[:template],
|
||||||
:boilerplate => triad[:boilerplate],
|
:boilerplate => triad[:boilerplate],
|
||||||
:includes => case(triad[:inc])
|
:includes => case(triad[:inc])
|
||||||
when :src then @includes[:src] | pattern_traits[:inc].map{|f| f % [@module_name]}
|
when :src then @options[:includes][:src] | pattern_traits[:inc].map{|f| f % [module_name]}
|
||||||
when :inc then @includes[:inc]
|
when :inc then @options[:includes][:inc]
|
||||||
when :tst then @includes[:tst] | pattern_traits[:inc].map{|f| "Mock#{f}"% [@module_name]}
|
when :tst then @options[:includes][:tst] | pattern_traits[:inc].map{|f| "Mock#{f}"% [module_name]}
|
||||||
end
|
end
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# destroy files if that was what was requested
|
return files
|
||||||
if @destroy
|
end
|
||||||
files.each do |filespec|
|
|
||||||
|
############################
|
||||||
|
def generate(module_name, pattern=nil)
|
||||||
|
|
||||||
|
files = files_to_operate_on(module_name, pattern)
|
||||||
|
|
||||||
|
#Abort if any module already exists
|
||||||
|
files.each do |file|
|
||||||
|
raise "ERROR: File #{file[:name]} already exists. Exiting." if File.exist?(file[:path])
|
||||||
|
end
|
||||||
|
|
||||||
|
# Create Source Modules
|
||||||
|
files.each_with_index do |file, i|
|
||||||
|
File.open(file[:path], 'w') do |f|
|
||||||
|
f.write(file[:boilerplate] % [file[:name]]) unless file[:boilerplate].nil?
|
||||||
|
f.write(file[:template] % [ file[:name],
|
||||||
|
file[:includes].map{|f| "#include \"#{f}\"\n"}.join,
|
||||||
|
file[:name].upcase ]
|
||||||
|
)
|
||||||
|
end
|
||||||
|
if (@options[:update_svn])
|
||||||
|
`svn add \"#{file[:path]}\"`
|
||||||
|
if $?.exitstatus == 0
|
||||||
|
puts "File #{file[:path]} created and added to source control"
|
||||||
|
else
|
||||||
|
puts "File #{file[:path]} created but FAILED adding to source control!"
|
||||||
|
end
|
||||||
|
else
|
||||||
|
puts "File #{file[:path]} created"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
puts 'Generate Complete'
|
||||||
|
end
|
||||||
|
|
||||||
|
############################
|
||||||
|
def destroy(module_name, pattern=nil)
|
||||||
|
|
||||||
|
files_to_operate_on(module_name, pattern).each do |filespec|
|
||||||
file = filespec[:path]
|
file = filespec[:path]
|
||||||
if File.exist?(file)
|
if File.exist?(file)
|
||||||
if @update_svn
|
if @options[:update_svn]
|
||||||
`svn delete \"#{file}\" --force`
|
`svn delete \"#{file}\" --force`
|
||||||
puts "File #{file} deleted and removed from source control"
|
puts "File #{file} deleted and removed from source control"
|
||||||
else
|
else
|
||||||
@ -170,33 +199,63 @@ if @destroy
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
puts "Destroy Complete"
|
puts "Destroy Complete"
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
############################
|
||||||
|
#Handle As Command Line If Called That Way
|
||||||
|
if ($0 == __FILE__)
|
||||||
|
destroy = false
|
||||||
|
options = { }
|
||||||
|
module_name = nil
|
||||||
|
|
||||||
|
# Parse the command line parameters.
|
||||||
|
ARGV.each do |arg|
|
||||||
|
case(arg)
|
||||||
|
when /^-d/ then destroy = true
|
||||||
|
when /^-u/ then options[:update_svn] = true
|
||||||
|
when /^-p(\w+)/ then options[:pattern] = $1
|
||||||
|
when /^-s(.+)/ then options[:path_src] = $1
|
||||||
|
when /^-i(.+)/ then options[:path_inc] = $1
|
||||||
|
when /^-t(.+)/ then options[:path_tst] = $1
|
||||||
|
when /^-y(.+)/ then options = UnityModuleGenerator.grab_config($1)
|
||||||
|
when /^(\w+)/
|
||||||
|
raise "ERROR: You can't have more than one Module name specified!" unless module_name.nil?
|
||||||
|
module_name = arg
|
||||||
|
when /^-(h|-help)/
|
||||||
|
ARGV = []
|
||||||
|
else
|
||||||
|
raise "ERROR: Unknown option specified '#{arg}'"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
if (!ARGV[0])
|
||||||
|
puts [ "\nGENERATE MODULE\n-------- ------",
|
||||||
|
"\nUsage: ruby generate_module [options] module_name",
|
||||||
|
" -i\"include\" sets the path to output headers to 'include' (DEFAULT ../src)",
|
||||||
|
" -s\"../src\" sets the path to output source to '../src' (DEFAULT ../src)",
|
||||||
|
" -t\"C:/test\" sets the path to output source to 'C:/test' (DEFAULT ../test)",
|
||||||
|
" -p\"MCH\" sets the output pattern to MCH.",
|
||||||
|
" dh - driver hardware.",
|
||||||
|
" dih - driver interrupt hardware.",
|
||||||
|
" mch - model conductor hardware.",
|
||||||
|
" mvp - model view presenter.",
|
||||||
|
" src - just a single source module. (DEFAULT)",
|
||||||
|
" -d destroy module instead of creating it.",
|
||||||
|
" -u update subversion too (requires subversion command line)",
|
||||||
|
" -y\"my.yml\" selects a different yaml config file for module generation",
|
||||||
|
"" ].join("\n")
|
||||||
exit
|
exit
|
||||||
end
|
|
||||||
|
|
||||||
#Abort if any module already exists
|
|
||||||
files.each do |file|
|
|
||||||
raise "ERROR: File #{file[:name]} already exists. Exiting." if File.exist?(file[:path])
|
|
||||||
end
|
|
||||||
|
|
||||||
# Create Source Modules
|
|
||||||
files.each_with_index do |file, i|
|
|
||||||
File.open(file[:path], 'w') do |f|
|
|
||||||
f.write(file[:boilerplate] % [file[:name]]) unless file[:boilerplate].nil?
|
|
||||||
f.write(file[:template] % [ file[:name],
|
|
||||||
file[:includes].map{|f| "#include \"#{f}\"\n"}.join,
|
|
||||||
file[:name].upcase ]
|
|
||||||
)
|
|
||||||
end
|
end
|
||||||
if (@update_svn)
|
|
||||||
`svn add \"#{file[:path]}\"`
|
raise "ERROR: You must have a Module name specified! (use option -h for help)" if module_name.nil?
|
||||||
if $?.exitstatus == 0
|
if (destroy)
|
||||||
puts "File #{file[:path]} created and added to source control"
|
UnityModuleGenerator.new(options).destroy(module_name)
|
||||||
else
|
else
|
||||||
puts "File #{file[:path]} created but FAILED adding to source control!"
|
UnityModuleGenerator.new(options).generate(module_name)
|
||||||
end
|
|
||||||
else
|
|
||||||
puts "File #{file[:path]} created"
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
puts 'Generate Complete'
|
|
||||||
|
|||||||
Reference in New Issue
Block a user