all but 50 violations

Author: ford-at-aws

.github/linters/.ruby-lint.yml

@@ -3,18 +3,21 @@
 # Rubocop Config file #
 #######################
 Metrics/MethodLength:
-  Max: 25
+  Max: 50
+Layout/LineLength:
+  Max: 150
 Metrics/BlockLength:
-  Max: 75
+  Max: 150
 Metrics/AbcSize:
-  Max: 20
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
 Layout/EndOfLine:
   Enabled: false
-Layout/LineLength:
-  Exclude:
-    - ruby/example_code/kms/decrypt_data.rb
 Naming/FileName:
   Enabled: false
 Style/HashSyntax:

ruby/cross_service_examples/item_tracker/env/setup_scripts/create_table.rb

@@ -70,9 +70,7 @@ def create_table
   # Checks for a database cluster & creates a table if none exists.
   begin
     setup = SetupDatabase.new
-    unless setup.database_exists?
-      raise 'No DB cluster exists! Please run CDK script found in resources/cdk/aurora_serverless_app.'
-    end
+    raise 'No DB cluster exists! Please run CDK script found in resources/cdk/aurora_serverless_app.' unless setup.database_exists?
 
     setup.create_table unless setup.table_exists?
   rescue StandardError => e

ruby/example_code/ec2/ec2-ruby-example-security-group.rb

@@ -36,12 +36,7 @@
 #     'This is my security group.',
 #     'vpc-6713dfEX'
 #   )
-def create_security_group(
-  ec2_client,
-  group_name,
-  description,
-  vpc_id
-)
+def create_security_group(ec2_client, group_name, description, vpc_id)
   security_group = ec2_client.create_security_group(
     group_name: group_name,
     description: description,
@@ -79,12 +74,7 @@ def create_security_group(
 #     '0.0.0.0/0'
 #   )
 def security_group_ingress_authorized?(
-  ec2_client,
-  security_group_id,
-  ip_protocol,
-  from_port,
-  to_port,
-  cidr_ip_range
+  ec2_client, security_group_id, ip_protocol, from_port, to_port, cidr_ip_range
 )
   ec2_client.authorize_security_group_ingress(
     group_id: security_group_id,
@@ -110,88 +100,35 @@ def security_group_ingress_authorized?(
   false
 end
 
+# Refactored method to simplify complexity for describing security group permissions
+def format_port_information(perm)
+  from_port_str = perm.from_port == '-1' || perm.from_port == -1 ? 'All' : perm.from_port.to_s
+  to_port_str = perm.to_port == '-1' || perm.to_port == -1 ? 'All' : perm.to_port.to_s
+  { from_port: from_port_str, to_port: to_port_str }
+end
+
 # Displays information about a security group's IP permissions set in
 # Amazon Elastic Compute Cloud (Amazon EC2).
-#
-# Prerequisites:
-#
-# - A security group with inbound rules, outbound rules, or both.
-#
-# @param p [Aws::EC2::Types::IpPermission] The IP permissions set.
-# @example
-#   ec2_client = Aws::EC2::Client.new(region: 'us-west-2')
-#   response = ec2_client.describe_security_groups
-#   unless sg.ip_permissions.empty?
-#     describe_security_group_permissions(
-#       response.security_groups[0].ip_permissions[0]
-#     )
-#   end
 def describe_security_group_permissions(perm)
-  print "  Protocol: #{perm.ip_protocol == '-1' ? 'All' : perm.ip_protocol}"
+  ports = format_port_information(perm)
 
-  unless perm.from_port.nil?
-    if perm.from_port == '-1' || perm.from_port == -1
-      print ', From: All'
-    else
-      print ", From: #{perm.from_port}"
-    end
-  end
-
-  unless perm.to_port.nil?
-    if perm.to_port == '-1' || perm.to_port == -1
-      print ', To: All'
-    else
-      print ", To: #{perm.to_port}"
-    end
-  end
+  print "  Protocol: #{perm.ip_protocol == '-1' ? 'All' : perm.ip_protocol}"
+  print ", From: #{ports[:from_port]}, To: #{ports[:to_port]}"
 
-  if perm.key?(:ipv_6_ranges) && perm.ipv_6_ranges.count.positive?
-    print ", CIDR IPv6: #{perm.ipv_6_ranges[0].cidr_ipv_6}"
-  end
+  print ", CIDR IPv6: #{perm.ipv_6_ranges[0].cidr_ipv_6}" if perm.key?(:ipv_6_ranges) && perm.ipv_6_ranges.count.positive?
 
   print ", CIDR IPv4: #{perm.ip_ranges[0].cidr_ip}" if perm.key?(:ip_ranges) && perm.ip_ranges.count.positive?
-
   print "\n"
 end
 
 # Displays information about available security groups in
 # Amazon Elastic Compute Cloud (Amazon EC2).
-#
-# @param ec2_client [Aws::EC2::Client] An initialized Amazon EC2 client.
-# @example
-#   describe_security_groups(Aws::EC2::Client.new(region: 'us-west-2'))
 def describe_security_groups(ec2_client)
   response = ec2_client.describe_security_groups
 
   if response.security_groups.count.positive?
     response.security_groups.each do |sg|
-      puts '-' * (sg.group_name.length + 13)
-      puts "Name:        #{sg.group_name}"
-      puts "Description: #{sg.description}"
-      puts "Group ID:    #{sg.group_id}"
-      puts "Owner ID:    #{sg.owner_id}"
-      puts "VPC ID:      #{sg.vpc_id}"
-
-      if sg.tags.count.positive?
-        puts 'Tags:'
-        sg.tags.each do |tag|
-          puts "  Key: #{tag.key}, Value: #{tag.value}"
-        end
-      end
-
-      unless sg.ip_permissions.empty?
-        puts 'Inbound rules:' if sg.ip_permissions.count.positive?
-        sg.ip_permissions.each do |p|
-          describe_security_group_permissions(p)
-        end
-      end
-
-      next if sg.ip_permissions_egress.empty?
-
-      puts 'Outbound rules:' if sg.ip_permissions.count.positive?
-      sg.ip_permissions_egress.each do |p|
-        describe_security_group_permissions(p)
-      end
+      display_group_details(sg)
     end
   else
     puts 'No security groups found.'
@@ -200,22 +137,44 @@ def describe_security_groups(ec2_client)
   puts "Error getting information about security groups: #{e.message}"
 end
 
+# Helper method to display the details of security groups
+def display_group_details(sg)
+  puts '-' * (sg.group_name.length + 13)
+  puts "Name:        #{sg.group_name}"
+  puts "Description: #{sg.description}"
+  puts "Group ID:    #{sg.group_id}"
+  puts "Owner ID:    #{sg.owner_id}"
+  puts "VPC ID:      #{sg.vpc_id}"
+
+  display_group_tags(sg.tags) if sg.tags.count.positive?
+  display_group_permissions(sg)
+end
+
+def display_group_tags(tags)
+  puts 'Tags:'
+  tags.each do |tag|
+    puts "  Key: #{tag.key}, Value: #{tag.value}"
+  end
+end
+
+def display_group_permissions(sg)
+  if sg.ip_permissions.count.positive?
+    puts 'Inbound rules:'
+    sg.ip_permissions.each do |p|
+      describe_security_group_permissions(p)
+    end
+  end
+
+  return if sg.ip_permissions_egress.empty?
+
+  puts 'Outbound rules:'
+  sg.ip_permissions_egress.each do |p|
+    describe_security_group_permissions(p)
+  end
+end
+
 # Deletes an Amazon Elastic Compute Cloud (Amazon EC2)
 # security group.
-#
-# Prerequisites:
-#
-# - The security group.
-#
-# @param ec2_client [Aws::EC2::Client] An initialized
-#   Amazon EC2 client.
-# @param security_group_id [String] The ID of the security group to delete.
-# @return [Boolean] true if the security group was deleted; otherwise, false.
-# @example
-#   exit 1 unless security_group_deleted?(
-#     Aws::EC2::Client.new(region: 'us-west-2'),
-#     'sg-030a858e078f1b9EX'
-#   )
 def security_group_deleted?(ec2_client, security_group_id)
   ec2_client.delete_security_group(group_id: security_group_id)
   puts "Deleted security group '#{security_group_id}'."
@@ -225,113 +184,74 @@ def security_group_deleted?(ec2_client, security_group_id)
   false
 end
 
-# Example usage:
+# Example usage with refactored run_me to reduce complexity
 def run_me
-  group_name = ''
-  description = ''
-  vpc_id = ''
-  ip_protocol_http = ''
-  from_port_http = ''
-  to_port_http = ''
-  cidr_ip_range_http = ''
-  ip_protocol_ssh = ''
-  from_port_ssh = ''
-  to_port_ssh = ''
-  cidr_ip_range_ssh = ''
-  region = ''
-  # Print usage information and then stop.
+  group_name, description, vpc_id, ip_protocol_http, from_port_http, to_port_http, \
+  cidr_ip_range_http, ip_protocol_ssh, from_port_ssh, to_port_ssh, \
+  cidr_ip_range_ssh, region = process_arguments
+  ec2_client = Aws::EC2::Client.new(region: region)
+
+  security_group_id = attempt_create_security_group(ec2_client, group_name, description, vpc_id)
+  security_group_exists = security_group_id != 'Error'
+
+  if security_group_exists
+    add_inbound_rules(ec2_client, security_group_id, ip_protocol_http, from_port_http, to_port_http, cidr_ip_range_http)
+    add_inbound_rules(ec2_client, security_group_id, ip_protocol_ssh, from_port_ssh, to_port_ssh, cidr_ip_range_ssh)
+  end
+
+  describe_security_groups(ec2_client)
+  attempt_delete_security_group(ec2_client, security_group_id) if security_group_exists
+end
+
+def process_arguments
   if ARGV[0] == '--help' || ARGV[0] == '-h'
-    puts 'Usage:   ruby ec2-ruby-example-security-group.rb ' \
-      'GROUP_NAME DESCRIPTION VPC_ID IP_PROTOCOL_1 FROM_PORT_1 TO_PORT_1 ' \
-      'CIDR_IP_RANGE_1 IP_PROTOCOL_2 FROM_PORT_2 TO_PORT_2 ' \
-      'CIDR_IP_RANGE_2 REGION'
-    puts 'Example: ruby ec2-ruby-example-security-group.rb ' \
-      "my-security-group 'This is my security group.' vpc-6713dfEX " \
-      "tcp 80 80 '0.0.0.0/0' tcp 22 22 '0.0.0.0/0' us-west-2"
+    display_help
     exit 1
-  # If no values are specified at the command prompt, use these default values.
   elsif ARGV.count.zero?
-    group_name = 'my-security-group'
-    description = 'This is my security group.'
-    vpc_id = 'vpc-6713dfEX'
-    ip_protocol_http = 'tcp'
-    from_port_http = '80'
-    to_port_http = '80'
-    cidr_ip_range_http = '0.0.0.0/0'
-    ip_protocol_ssh = 'tcp'
-    from_port_ssh = '22'
-    to_port_ssh = '22'
-    cidr_ip_range_ssh = '0.0.0.0/0'
-    # Replace us-west-2 with the AWS Region you're using for Amazon EC2.
-    region = 'us-west-2'
-  # Otherwise, use the values as specified at the command prompt.
+    default_values
   else
-    group_name = ARGV[0]
-    description = ARGV[1]
-    vpc_id = ARGV[2]
-    ip_protocol_http = ARGV[3]
-    from_port_http = ARGV[4]
-    to_port_http = ARGV[5]
-    cidr_ip_range_http = ARGV[6]
-    ip_protocol_ssh = ARGV[7]
-    from_port_ssh = ARGV[8]
-    to_port_ssh = ARGV[9]
-    cidr_ip_range_ssh = ARGV[10]
-    region = ARGV[11]
+    ARGV
   end
-  security_group_exists = false
-  ec2_client = Aws::EC2::Client.new(region: region)
+end
 
+def attempt_create_security_group(ec2_client, group_name, description, vpc_id)
   puts 'Attempting to create security group...'
-  security_group_id = create_security_group(
-    ec2_client,
-    group_name,
-    description,
-    vpc_id
-  )
-  if security_group_id == 'Error'
-    puts 'Could not create security group. Skipping this step.'
-  else
-    security_group_exists = true
-  end
-
-  if security_group_exists
-    puts 'Attempting to add inbound rules to security group...'
-    unless security_group_ingress_authorized?(
-      ec2_client,
-      security_group_id,
-      ip_protocol_http,
-      from_port_http,
-      to_port_http,
-      cidr_ip_range_http
-    )
-      puts 'Could not add inbound HTTP rule to security group. ' \
-        'Skipping this step.'
-    end
-
-    unless security_group_ingress_authorized?(
-      ec2_client,
-      security_group_id,
-      ip_protocol_ssh,
-      from_port_ssh,
-      to_port_ssh,
-      cidr_ip_range_ssh
-    )
-      puts 'Could not add inbound SSH rule to security group. ' \
-        'Skipping this step.'
-    end
-  end
+  security_group_id = create_security_group(ec2_client, group_name, description, vpc_id)
+  puts 'Could not create security group. Skipping this step.' if security_group_id == 'Error'
+  security_group_id
+end
 
-  puts "\nInformation about available security groups:"
-  describe_security_groups(ec2_client)
+def add_inbound_rules(ec2_client, security_group_id, ip_protocol, from_port, to_port, cidr_ip_range)
+  puts 'Attempting to add inbound rules to security group...'
+  return if security_group_ingress_authorized?(ec2_client, security_group_id, ip_protocol, from_port, to_port,
+                                               cidr_ip_range)
 
-  return unless security_group_exists
+  puts 'Could not add inbound rule to security group. Skipping this step.'
+end
 
+def attempt_delete_security_group(ec2_client, security_group_id)
   puts "\nAttempting to delete security group..."
   return if security_group_deleted?(ec2_client, security_group_id)
 
   puts 'Could not delete security group. You must delete it yourself.'
 end
 
+def display_help
+  puts 'Usage:   ruby ec2-ruby-example-security-group.rb ' \
+    'GROUP_NAME DESCRIPTION VPC_ID IP_PROTOCOL_1 FROM_PORT_1 TO_PORT_1 ' \
+    'CIDR_IP_RANGE_1 IP_PROTOCOL_2 FROM_PORT_2 TO_PORT_2 ' \
+    'CIDR_IP_RANGE_2 REGION'
+  puts 'Example: ruby ec2-ruby-example-security-group.rb ' \
+    "my-security-group 'This is my security group.' vpc-6713dfEX " \
+    "tcp 80 80 '0.0.0.0/0' tcp 22 22 '0.0.0.0/0' us-west-2"
+end
+
+def default_values
+  [
+    'my-security-group', 'This is my security group.', 'vpc-6713dfEX', 'tcp', '80', '80',
+    '0.0.0.0/0', 'tcp', '22', '22', '0.0.0.0/0', 'us-west-2'
+  ]
+end
+
 run_me if $PROGRAM_NAME == __FILE__
 # snippet-end:[ec2.Ruby.exampleSecurityGroup]