summaryrefslogtreecommitdiffstats
path: root/lib/puppet/util/reference.rb
diff options
context:
space:
mode:
authorMarkus Roberts <Markus@reality.com>2010-07-09 18:05:55 -0700
committerMarkus Roberts <Markus@reality.com>2010-07-09 18:05:55 -0700
commite8cf06336b64491a2dd7538a06651e0caaf6a48d (patch)
tree9f5d4c83d03fefa54c385462f60875056a58a82c /lib/puppet/util/reference.rb
parenteefccf252527dc5b69af5959b0b0e2ddb5c91b74 (diff)
downloadpuppet-e8cf06336b64491a2dd7538a06651e0caaf6a48d.tar.gz
puppet-e8cf06336b64491a2dd7538a06651e0caaf6a48d.tar.xz
puppet-e8cf06336b64491a2dd7538a06651e0caaf6a48d.zip
Code smell: Use string interpolation
* Replaced 83 occurances of (.*)" *[+] *([$@]?[\w_0-9.:]+?)(.to_s\b)?(?! *[*(%\w_0-9.:{\[]) with \1#{\2}" 3 Examples: The code: puts "PUPPET " + status + ": " + process + ", " + state becomes: puts "PUPPET " + status + ": " + process + ", #{state}" The code: puts "PUPPET " + status + ": #{process}" + ", #{state}" becomes: puts "PUPPET #{status}" + ": #{process}" + ", #{state}" The code: }.compact.join( "\n" ) + "\n" + t + "]\n" becomes: }.compact.join( "\n" ) + "\n#{t}" + "]\n" * Replaced 21 occurances of (.*)" *[+] *" with \1 3 Examples: The code: puts "PUPPET #{status}" + ": #{process}" + ", #{state}" becomes: puts "PUPPET #{status}" + ": #{process}, #{state}" The code: puts "PUPPET #{status}" + ": #{process}, #{state}" becomes: puts "PUPPET #{status}: #{process}, #{state}" The code: res = self.class.name + ": #{@name}" + "\n" becomes: res = self.class.name + ": #{@name}\n" * Don't use string concatenation to split lines unless they would be very long. Replaced 11 occurances of (.*)(['"]) *[+] *(['"])(.*) with 3 Examples: The code: o.define_head "The check_puppet Nagios plug-in checks that specified " + "Puppet process is running and the state file is no " + becomes: o.define_head "The check_puppet Nagios plug-in checks that specified Puppet process is running and the state file is no " + The code: o.separator "Mandatory arguments to long options are mandatory for " + "short options too." becomes: o.separator "Mandatory arguments to long options are mandatory for short options too." The code: o.define_head "The check_puppet Nagios plug-in checks that specified Puppet process is running and the state file is no " + "older than specified interval." becomes: o.define_head "The check_puppet Nagios plug-in checks that specified Puppet process is running and the state file is no older than specified interval." * Replaced no occurances of do (.*?) end with {\1} * Replaced 1488 occurances of "([^"\n]*%s[^"\n]*)" *% *(.+?)(?=$| *\b(do|if|while|until|unless|#)\b) with 20 Examples: The code: args[0].split(/\./).map do |s| "dc=%s"%[s] end.join(",") becomes: args[0].split(/\./).map do |s| "dc=#{s}" end.join(",") The code: puts "%s" % Puppet.version becomes: puts "#{Puppet.version}" The code: raise "Could not find information for %s" % node becomes: raise "Could not find information for #{node}" The code: raise Puppet::Error, "Cannot create %s: basedir %s is a file" % [dir, File.join(path)] becomes: raise Puppet::Error, "Cannot create #{dir}: basedir #{File.join(path)} is a file" The code: Puppet.err "Could not run %s: %s" % [client_class, detail] becomes: Puppet.err "Could not run #{client_class}: #{detail}" The code: raise "Could not find handler for %s" % arg becomes: raise "Could not find handler for #{arg}" The code: Puppet.err "Will not start without authorization file %s" % Puppet[:authconfig] becomes: Puppet.err "Will not start without authorization file #{Puppet[:authconfig]}" The code: raise Puppet::Error, "Could not deserialize catalog from pson: %s" % detail becomes: raise Puppet::Error, "Could not deserialize catalog from pson: #{detail}" The code: raise "Could not find facts for %s" % Puppet[:certname] becomes: raise "Could not find facts for #{Puppet[:certname]}" The code: raise ArgumentError, "%s is not readable" % path becomes: raise ArgumentError, "#{path} is not readable" The code: raise ArgumentError, "Invalid handler %s" % name becomes: raise ArgumentError, "Invalid handler #{name}" The code: debug "Executing '%s' in zone %s with '%s'" % [command, @resource[:name], str] becomes: debug "Executing '#{command}' in zone #{@resource[:name]} with '#{str}'" The code: raise Puppet::Error, "unknown cert type '%s'" % hash[:type] becomes: raise Puppet::Error, "unknown cert type '#{hash[:type]}'" The code: Puppet.info "Creating a new certificate request for %s" % Puppet[:certname] becomes: Puppet.info "Creating a new certificate request for #{Puppet[:certname]}" The code: "Cannot create alias %s: object already exists" % [name] becomes: "Cannot create alias #{name}: object already exists" The code: return "replacing from source %s with contents %s" % [metadata.source, metadata.checksum] becomes: return "replacing from source #{metadata.source} with contents #{metadata.checksum}" The code: it "should have a %s parameter" % param do becomes: it "should have a #{param} parameter" do The code: describe "when registring '%s' messages" % log do becomes: describe "when registring '#{log}' messages" do The code: paths = %w{a b c d e f g h}.collect { |l| "/tmp/iteration%stest" % l } becomes: paths = %w{a b c d e f g h}.collect { |l| "/tmp/iteration#{l}test" } The code: assert_raise(Puppet::Error, "Check '%s' did not fail on false" % check) do becomes: assert_raise(Puppet::Error, "Check '#{check}' did not fail on false") do
Diffstat (limited to 'lib/puppet/util/reference.rb')
-rw-r--r--lib/puppet/util/reference.rb24
1 files changed, 12 insertions, 12 deletions
diff --git a/lib/puppet/util/reference.rb b/lib/puppet/util/reference.rb
index 74d75bb3f..c5bfe4722 100644
--- a/lib/puppet/util/reference.rb
+++ b/lib/puppet/util/reference.rb
@@ -11,7 +11,7 @@ class Puppet::Util::Reference
instance_load(:reference, 'puppet/reference')
def self.footer
- "\n\n----------------\n\n*This page autogenerated on %s*\n" % Time.now
+ "\n\n----------------\n\n*This page autogenerated on #{Time.now}*\n"
end
def self.modes
@@ -29,7 +29,7 @@ class Puppet::Util::Reference
depth = 4
# Use the minimum depth
sections.each do |name|
- section = reference(name) or raise "Could not find section %s" % name
+ section = reference(name) or raise "Could not find section #{name}"
depth = section.depth if section.depth < depth
end
text = ".. contents:: :depth: 2\n\n"
@@ -69,9 +69,9 @@ class Puppet::Util::Reference
def self.markdown(name, text)
puts "Creating markdown for #{name} reference."
- dir = "/tmp/" + Puppet::PUPPETVERSION
+ dir = "/tmp/#{Puppet::PUPPETVERSION}"
FileUtils.mkdir(dir) unless File.directory?(dir)
- Puppet::Util.secure_open(dir + "/" + "#{name}.rst", "w") do |f|
+ Puppet::Util.secure_open(dir + "/#{name}.rst", "w") do |f|
f.puts text
end
pandoc = %x{which pandoc}
@@ -90,7 +90,7 @@ class Puppet::Util::Reference
exit(1)
end
- File.unlink(dir + "/" + "#{name}.rst")
+ File.unlink(dir + "/#{name}.rst")
end
def self.references
@@ -105,7 +105,7 @@ class Puppet::Util::Reference
def doc
if defined?(@doc)
- return "%s - %s" % [@name, @doc]
+ return "#{@name} - #{@doc}"
else
return @title
end
@@ -116,7 +116,7 @@ class Puppet::Util::Reference
end
def h(name, level)
- return "%s\n%s\n\n" % [name, HEADER_LEVELS[level] * name.to_s.length]
+ return "#{name}\n#{HEADER_LEVELS[level] * name.to_s.length}\n\n"
end
def initialize(name, options = {}, &block)
@@ -128,7 +128,7 @@ class Puppet::Util::Reference
meta_def(:generate, &block)
# Now handle the defaults
- @title ||= "%s Reference" % @name.to_s.capitalize
+ @title ||= "#{@name.to_s.capitalize} Reference"
@page ||= @title.gsub(/\s+/, '')
@depth ||= 2
@header ||= ""
@@ -140,12 +140,12 @@ class Puppet::Util::Reference
end
def option(name, value)
- ":%s: %s\n" % [name.to_s.capitalize, value]
+ ":#{name.to_s.capitalize}: #{value}\n"
end
def paramwrap(name, text, options = {})
options[:level] ||= 5
- #str = "%s : " % name
+ #str = "#{name} : "
str = h(name, options[:level])
if options[:namevar]
str += "- **namevar**\n\n"
@@ -171,7 +171,7 @@ class Puppet::Util::Reference
text = h(@title, 1)
text += "\n\n**This page is autogenerated; any changes will get overwritten** *(last generated on #{Time.now.to_s})*\n\n"
if withcontents
- text += ".. contents:: :depth: %s\n\n" % @depth
+ text += ".. contents:: :depth: #{@depth}\n\n"
end
text += @header
@@ -198,7 +198,7 @@ class Puppet::Util::Reference
f.puts self.to_trac
end
- puts "Writing %s reference to trac as %s" % [@name, @page]
+ puts "Writing #{@name} reference to trac as #{@page}"
cmd = %{sudo trac-admin /opt/rl/trac/puppet wiki import %s /tmp/puppetdoc.txt} % self.page
output = %x{#{cmd}}
unless $CHILD_STATUS == 0