Module: UsePackwerk::Private::PackRelationshipAnalyzer

Extended by:
T::Sig
Defined in:
lib/use_packwerk/private/pack_relationship_analyzer.rb

Class Method Summary collapse

Class Method Details

.list_top_dependency_violations(pack_name, limit) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/use_packwerk/private/pack_relationship_analyzer.rb', line 77

def self.list_top_dependency_violations(pack_name, limit)
  all_packages = ParsePackwerk.all

  if pack_name.nil?
    to_package_names = all_packages.map(&:name)
  else
    pack_name = Private.clean_pack_name(pack_name)
    package = all_packages.find { |p| p.name == pack_name }
    if package.nil?
      raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
    end

    to_package_names = [pack_name]
  end

  Logging.section('👋 Hi there') do
    intro = UsePackwerk.config.user_event_logger.before_list_top_dependency_violations(pack_name, limit)
    Logging.print_bold_green(intro)
  end

  violations_by_count = {}
  total_pack_violation_count = 0

  # TODO: This is a copy of the implementation above. We may want to refactor out this implementation detail before making changes that apply to both.
  all_packages.each do |client_package|
    client_package.violations.select(&:dependency?).each do |violation|
      next unless to_package_names.include?(violation.to_package_name)

      if pack_name.nil?
        violated_symbol = "#{violation.class_name} (#{violation.to_package_name})"
      else
        violated_symbol = violation.class_name
      end
      violations_by_count[violated_symbol] ||= {}
      violations_by_count[violated_symbol][:total_count] ||= 0
      violations_by_count[violated_symbol][:by_package] ||= {}
      violations_by_count[violated_symbol][:by_package][client_package.name] ||= 0
      violations_by_count[violated_symbol][:total_count] += violation.files.count
      violations_by_count[violated_symbol][:by_package][client_package.name] += violation.files.count
      total_pack_violation_count += violation.files.count
    end
  end

  Logging.print("Total Count: #{total_pack_violation_count}")

  sorted_violations = violations_by_count.sort_by { |violated_symbol, count_info| [-count_info[:total_count], violated_symbol] }
  sorted_violations.first(limit).each do |violated_symbol, count_info|
    percentage_of_total = (count_info[:total_count] * 100.0 / total_pack_violation_count).round(2)
    Logging.print(violated_symbol)
    Logging.print("  - Total Count: #{count_info[:total_count]} (#{percentage_of_total}% of total)")
    Logging.print('  - By package:')
    count_info[:by_package].sort_by { |client_package_name, count| [-count, client_package_name] }.each do |client_package_name, count|
      Logging.print("    - #{client_package_name}: #{count}")
    end
  end
end

.list_top_privacy_violations(pack_name, limit) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/use_packwerk/private/pack_relationship_analyzer.rb', line 14

def self.list_top_privacy_violations(pack_name, limit)
  all_packages = ParsePackwerk.all
  if pack_name.nil?
    to_package_names = all_packages.map(&:name)
  else
    pack_name = Private.clean_pack_name(pack_name)
    package = all_packages.find { |p| p.name == pack_name }
    if package.nil?
      raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
    end

    to_package_names = [pack_name]
  end

  violations_by_count = {}
  total_pack_violation_count = 0

  Logging.section('👋 Hi there') do
    intro = UsePackwerk.config.user_event_logger.before_list_top_privacy_violations(pack_name, limit)
    Logging.print_bold_green(intro)
  end

  # TODO: This is a copy of the implementation below. We may want to refactor out this implementation detail before making changes that apply to both.
  all_packages.each do |client_package|
    client_package.violations.select(&:privacy?).each do |violation|
      next unless to_package_names.include?(violation.to_package_name)

      if pack_name.nil?
        violated_symbol = "#{violation.class_name} (#{violation.to_package_name})"
      else
        violated_symbol = violation.class_name
      end
      violations_by_count[violated_symbol] ||= {}
      violations_by_count[violated_symbol][:total_count] ||= 0
      violations_by_count[violated_symbol][:by_package] ||= {}
      violations_by_count[violated_symbol][:by_package][client_package.name] ||= 0
      violations_by_count[violated_symbol][:total_count] += violation.files.count
      violations_by_count[violated_symbol][:by_package][client_package.name] += violation.files.count
      total_pack_violation_count += violation.files.count
    end
  end

  Logging.print("Total Count: #{total_pack_violation_count}")

  sorted_violations = violations_by_count.sort_by { |violated_symbol, count_info| [-count_info[:total_count], violated_symbol] }
  sorted_violations.first(limit).each do |violated_symbol, count_info|
    percentage_of_total = (count_info[:total_count] * 100.0 / total_pack_violation_count).round(2)
    Logging.print(violated_symbol)
    Logging.print("  - Total Count: #{count_info[:total_count]} (#{percentage_of_total}% of total)")

    Logging.print('  - By package:')
    count_info[:by_package].sort_by { |client_package_name, count| [-count, client_package_name] }.each do |client_package_name, count|
      Logging.print("    - #{client_package_name}: #{count}")
    end
  end
end