(MAINT) Rubocop: Fix Layout/EmptyLineAfterGuardClause

Author: scotje

Rakefile

@@ -95,10 +95,12 @@ namespace :litmus do
     `gem build puppet-strings.gemspec --quiet`
     result = $CHILD_STATUS
     raise "Unable to build the puppet-strings gem. Returned exit code #{result.exitstatus}" unless result.exitstatus.zero?
+
     puts 'Built'
     # Find the gem build artifact
     gem_tar = Dir.glob('puppet-strings-*.gem').max_by { |f| File.mtime(f) }
     raise "Unable to find package in 'puppet-strings-*.gem'" if gem_tar.nil?
+
     gem_tar = File.expand_path(gem_tar)
 
     target_string = if args[:target_node_name].nil?

lib/puppet-strings/tasks/gh_pages.rb

@@ -7,6 +7,7 @@
     task :checkout do
       if Dir.exist?('doc')
         fail "The 'doc' directory (#{File.expand_path('doc')}) is not a Git repository! Remove it and run the Rake task again." unless Dir.exist?('doc/.git')
+
         Dir.chdir('doc') do
           system 'git checkout gh-pages'
           system 'git pull --rebase origin gh-pages'

lib/puppet-strings/yard.rb

@@ -104,6 +104,7 @@ def stats_for_puppet_tasks
 
   def stats_for_puppet_plans
     return unless PuppetStrings.puppet_5?
+
     output 'Puppet Plans', *type_statistics_all(:puppet_plan)
   end
 

lib/puppet-strings/yard/code_objects/function.rb

@@ -63,6 +63,7 @@ def function_type
   # @return [String] Returns the Puppet signature of the function.
   def signature
     return '' if self.has_tag? :overload
+
     tags = self.tags(:param)
     args = @parameters.map do |parameter|
       name, default = parameter

lib/puppet-strings/yard/code_objects/group.rb

@@ -12,6 +12,7 @@ class PuppetStrings::Yard::CodeObjects::Group < PuppetStrings::Yard::CodeObjects
   def self.instance(key)
     instance = P(:root, key)
     return instance unless instance.is_a?(YARD::CodeObjects::Proxy)
+
     instance = self.new(:root, key)
     instance.visibility = :hidden
     P(:root).children << instance

lib/puppet-strings/yard/code_objects/provider.rb

@@ -44,6 +44,7 @@ def type
   # @return [void]
   def add_confine(key, value)
     return unless key && value
+
     @confines ||= {}
     @confines[key] = value
   end
@@ -53,6 +54,7 @@ def add_confine(key, value)
   # @return [void]
   def add_feature(feature)
     return unless feature
+
     @features ||= []
     @features << feature
   end
@@ -62,6 +64,7 @@ def add_feature(feature)
   # @return [void]
   def add_default(constraints)
     return unless constraints
+
     @defaults ||= []
     @defaults << constraints
   end
@@ -72,6 +75,7 @@ def add_default(constraints)
   # @return [void]
   def add_command(key, value)
     return unless key && value
+
     @commands ||= {}
     @commands[key] = value
   end

lib/puppet-strings/yard/code_objects/type.rb

@@ -169,6 +169,7 @@ def parameters
   def providers
     providers = YARD::Registry.all("puppet_providers_#{name}".intern)
     return providers if providers.empty?
+
     providers.first.children
   end
 

lib/puppet-strings/yard/handlers/puppet/base.rb

@@ -19,6 +19,7 @@ def set_parameter_types(object)
     tags = object.tags(:param)
     tags.each do |tag|
       next if statement.parameters.find { |p| tag.name == p.name }
+
       log.warn "The @param tag for parameter '#{tag.name}' has no matching parameter at #{statement.file}:#{statement.line}." unless tag.name == 'name' || tag.name == 'title'
     end
 

lib/puppet-strings/yard/handlers/ruby/base.rb

@@ -14,6 +14,7 @@ class PuppetStrings::Yard::Handlers::Ruby::Base < YARD::Handlers::Ruby::Base
   # @return [String] Returns a string representation of the node or nil if a string representation was not possible.
   def node_as_string(node)
     return nil unless node
+
     case node.type
     when :symbol, :symbol_literal
       node.source[1..-1]
@@ -44,8 +45,10 @@ def node_as_string(node)
   def get_name(statementobject, statementtype)
     parameters = statementobject.parameters(false)
     raise YARD::Parser::UndocumentableError, "Expected at least one parameter to #{statementtype} at #{statementobject.file}:#{statementobject.line}." if parameters.empty?
+
     name = node_as_string(parameters.first)
     raise YARD::Parser::UndocumentableError, "Expected a symbol or string literal for first parameter but found '#{parameters.first.type}' at #{statement.file}:#{statement.line}." unless name
+
     name
   end
 end

lib/puppet-strings/yard/handlers/ruby/data_type_handler.rb

@@ -12,8 +12,10 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
 
   process do
     return unless statement.count > 1
+
     ruby_module_name = statement[0].source
     return unless ruby_module_name == 'Puppet::DataTypes' || ruby_module_name == 'DataTypes' # rubocop:disable Style/MultipleComparison This reads better
+
     object = get_datatype_yard_object(get_name(statement, 'Puppet::DataTypes.create_type'))
     # Extract the interface definition
     type_interface = extract_data_type_interface
@@ -67,8 +69,10 @@ def extract_data_type_interface
       next false unless node.is_a?(YARD::Parser::Ruby::MethodCallNode) &&
                         node.method_name &&
                         node.method_name.source == 'interface'
+
       parameters = node.parameters(false)
       next false unless parameters.count >= 1
+
       interface_string = node_as_string(parameters[0])
       next false unless interface_string
 
@@ -99,8 +103,10 @@ def extract_data_type_interface
   # @return [YARD::Parser::Ruby::AstNode, nil]
   def find_ruby_ast_node(ast_node, recurse = false, &block)
     raise ArgumentError, 'find_ruby_ast_node requires a block' unless block_given?
+
     is_found = yield ast_node
     return ast_node if is_found
+
     if ast_node.respond_to?(:children)
       ast_node.children.each do |child_node|
         child_found = find_ruby_ast_node(child_node, recurse, &block)
@@ -277,8 +283,10 @@ def validate_param_tags!(object, actual_params_hash)
     # Find param tags with a type that is different from the actual definition
     object.tags(:param).reject { |tag| tag.types.nil? }.each do |tag|
       next if actual_params_hash[tag.name].nil?
+
       actual_data_type = actual_params_hash[tag.name][:types]
       next if actual_data_type.nil?
+
       log.warn "The @param tag for '#{tag.name}' has a different type definition than the actual attribute near #{object.file}:#{object.line}." if tag.types != actual_data_type
     end
 
@@ -292,6 +300,7 @@ def validate_param_tags!(object, actual_params_hash)
     # Set the type in the param tag
     object.tags(:param).each do |tag|
       next if actual_params_hash[tag.name].nil?
+
       tag.types = actual_params_hash[tag.name][:types]
     end
   end
@@ -313,10 +322,13 @@ def validate_methods!(object, actual_functions_hash)
     # Functions with the wrong return type
     object.meths.each do |meth|
       next unless actual_func_names.include?(meth.name.to_s)
+
       return_tag = meth.docstring.tag(:return)
       next if return_tag.nil?
+
       actual_return_types = [actual_functions_hash[meth.name.to_s][:return_type]]
       next if return_tag.types == actual_return_types
+
       log.warn "The @return tag for '#{meth.name}' has a different type definition than the actual function near #{object.file}:#{object.line}. Expected #{actual_return_types}"
       return_tag.types = actual_return_types
     end
@@ -331,13 +343,15 @@ def validate_methods!(object, actual_functions_hash)
     # Add the return type for the methods if missing
     object.meths.each do |meth|
       next unless meth.docstring.tag(:return).nil?
+
       meth.docstring.add_tag(YARD::Tags::Tag.new(:return, '', actual_functions_hash[meth.name.to_s][:return_type]))
     end
 
     # Sync the method properties and add the return type for the methods if missing
     object.meths.each do |meth|
       validate_function_method!(object, meth, actual_functions_hash[meth.name.to_s])
       next unless meth.docstring.tag(:return).nil?
+
       meth.docstring.add_tag(YARD::Tags::Tag.new(:return, '', actual_functions_hash[meth.name.to_s][:return_type]))
     end
 

lib/puppet-strings/yard/handlers/ruby/function_handler.rb

@@ -31,6 +31,7 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
     # newline, YARD ignores the namespace and uses `newfunction` as the source of the
     # first statement.
     return unless statement.count > 1
+
     module_name = statement[0].source
     return unless module_name == 'Puppet::Functions' || module_name == 'Puppet::Parser::Functions' || module_name == 'newfunction'
 
@@ -330,6 +331,7 @@ def validate_overload(overload, file, line)
     # Validate that tags have matching parameters
     overload.tags(:param).each do |tag|
       next if overload.parameters.find { |p| tag.name == p[0] }
+
       log.warn "The @param tag for parameter '#{tag.name}' has no matching parameter at #{file}:#{line}."
     end
   end
@@ -340,9 +342,11 @@ def get_3x_docstring(name)
       parameters[1].each do |kvp|
         next unless kvp.count == 2
         next unless node_as_string(kvp[0]) == 'doc'
+
         docstring = node_as_string(kvp[1])
 
         log.error "Failed to parse docstring for 3.x Puppet function '#{name}' near #{statement.file}:#{statement.line}." and return nil unless docstring
+
         return PuppetStrings::Yard::Util.scrub_string(docstring)
       end
     end

lib/puppet-strings/yard/handlers/ruby/provider_handler.rb

@@ -22,6 +22,7 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
     # Extract the type name
     type_call_parameters = type_call.parameters(false)
     return unless type_call_parameters.count >= 1
+
     type_name = node_as_string(type_call_parameters.first)
     raise YARD::Parser::UndocumentableError, "Could not determine the resource type name for the provider defined at #{statement.file}:#{statement.line}." unless type_name
 
@@ -49,8 +50,10 @@ def register_provider_docstring(object)
       if child.type == :assign
         ivar = child.jump(:ivar)
         next unless ivar != child && ivar.source == '@doc'
+
         docstring = node_as_string(child[1])
         log.error "Failed to parse docstring for Puppet provider '#{object.name}' (resource type '#{object.type_name}') near #{child.file}:#{child.line}." and return nil unless docstring
+
         register_docstring(object, PuppetStrings::Yard::Util.scrub_string(docstring), nil)
         return nil
       elsif child.is_a?(YARD::Parser::Ruby::MethodCallNode)
@@ -62,6 +65,7 @@ def register_provider_docstring(object)
 
         docstring = node_as_string(child.parameters[0])
         log.error "Failed to parse docstring for Puppet provider '#{object.name}' (resource type '#{object.type_name}') near #{child.file}:#{child.line}." and return nil unless docstring
+
         register_docstring(object, PuppetStrings::Yard::Util.scrub_string(docstring), nil)
         return nil
       end
@@ -73,6 +77,7 @@ def populate_provider_data(object)
     # Traverse the block looking for confines/defaults/commands
     block = statement.block
     return unless block && block.count >= 2
+
     block[1].children.each do |node|
       next unless node.is_a?(YARD::Parser::Ruby::MethodCallNode) && node.method_name
 
@@ -82,8 +87,10 @@ def populate_provider_data(object)
       if method_name == 'confine'
         # Add a confine to the object
         next unless parameters.count >= 1
+
         parameters[0].each do |kvp|
           next unless kvp.count == 2
+
           object.add_confine(node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source)
         end
       elsif method_name == 'has_feature' || method_name == 'has_features'
@@ -94,9 +101,11 @@ def populate_provider_data(object)
       elsif method_name == 'defaultfor'
         # Add a default to the object
         next unless parameters.count >= 1
+
         # Some defaultfor statements contain multiple constraints.
         parameters.each do |kvps|
           next unless kvps.count >= 1
+
           defaultfor = []
           kvps.each do |kvp|
             defaultfor << [node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source]
@@ -106,8 +115,10 @@ def populate_provider_data(object)
       elsif method_name == 'commands'
         # Add the commands to the object
         next unless parameters.count >= 1
+
         parameters[0].each do |kvp|
           next unless kvp.count == 2
+
           object.add_command(node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source)
         end
       end

lib/puppet-strings/yard/handlers/ruby/rsapi_handler.rb

@@ -16,6 +16,7 @@ class PuppetStrings::Yard::Handlers::Ruby::RsapiHandler < PuppetStrings::Yard::H
   process do
     # Only accept calls to Puppet::ResourceApi
     return unless statement.count > 1
+
     module_name = statement[0].source
     return unless ['Puppet::ResourceApi'].include? module_name
 

lib/puppet-strings/yard/handlers/ruby/type_base.rb

@@ -24,8 +24,10 @@ def find_docstring(node, kind)
       if child.type == :assign
         ivar = child.jump(:ivar)
         next unless ivar != child && ivar.source == '@doc'
+
         docstring = node_as_string(child[1])
         log.error "Failed to parse docstring for #{kind} near #{child.file}:#{child.line}." and return nil unless docstring
+
         return PuppetStrings::Yard::Util.scrub_string(docstring)
       elsif child.is_a?(YARD::Parser::Ruby::MethodCallNode)
         # Look for a call to a dispatch method with a block
@@ -35,6 +37,7 @@ def find_docstring(node, kind)
 
         docstring = node_as_string(child.parameters[0])
         log.error "Failed to parse docstring for #{kind} near #{child.file}:#{child.line}." and return nil unless docstring
+
         return PuppetStrings::Yard::Util.scrub_string(docstring)
       end
     end
@@ -71,16 +74,19 @@ def set_values(node, object)
 
       if method_name == 'newvalue'
         next unless parameters.count >= 1
+
         object.add(node_as_string(parameters[0]) || parameters[0].source)
       elsif method_name == 'newvalues'
         parameters.each do |p|
           object.add(node_as_string(p) || p.source)
         end
       elsif method_name == 'aliasvalue'
         next unless parameters.count >= 2
+
         object.alias(node_as_string(parameters[0]) || parameters[0].source, node_as_string(parameters[1]) || parameters[1].source)
       elsif method_name == 'defaultto'
         next unless parameters.count >= 1
+
         object.default = node_as_string(parameters[0]) || parameters[0].source
       elsif method_name == 'isnamevar'
         object.isnamevar = true
@@ -105,6 +111,7 @@ def set_values(node, object)
         parameters[1].each do |kvp|
           next unless kvp.count == 2
           next unless node_as_string(kvp[0]) == 'parent'
+
           if kvp[1].source == 'Puppet::Parameter::Boolean'
             object.add('true') unless object.values.include? 'true' # rubocop:disable Performance/InefficientHashSearch Not supported on Ruby 2.1
             object.add('false') unless object.values.include? 'false' # rubocop:disable Performance/InefficientHashSearch Not supported on Ruby 2.1
@@ -119,16 +126,19 @@ def set_values(node, object)
 
   def set_default_namevar(object)
     return unless object.properties || object.parameters
+
     default = nil
     if object.properties
       object.properties.each do |property|
         return nil if property.isnamevar
+
         default = property if property.name == 'name'
       end
     end
     if object.parameters
       object.parameters.each do |parameter|
         return nil if parameter.isnamevar
+
         default ||= parameter if parameter.name == 'name'
       end
     end

lib/puppet-strings/yard/handlers/ruby/type_extras_handler.rb

@@ -33,6 +33,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeExtrasHandler < PuppetStrings::Ya
     #   propertyname: "content"
 
     return unless (statement.count > 1) && (statement[0].children.count > 2)
+
     module_name = statement[0].children[0].source
     method1_name = statement[0].children.drop(1).find{ |c| c.type == :ident }.source
     return unless (module_name == 'Puppet::Type' || module_name == 'Type') && method1_name == 'type'