Class: Rails::CodeStatistics

Relationships & Source Files
Inherits:	Object
Defined in:	railties/lib/rails/code_statistics.rb

Constant Summary

DIRECTORIES =
# File 'railties/lib/rails/code_statistics.rb', line 8

[
  %w(Controllers        app/controllers),
  %w(Helpers            app/helpers),
  %w(Jobs               app/jobs),
  %w(Models             app/models),
  %w(Mailers            app/mailers),
  %w(Mailboxes          app/mailboxes),
  %w(Channels           app/channels),
  %w(Views              app/views),
  %w(JavaScripts        app/assets/javascripts),
  %w(Stylesheets        app/assets/stylesheets),
  %w(JavaScript         app/javascript),
  %w(Libraries          lib/),
  %w(APIs               app/apis),
  %w(Controller\ tests  test/controllers),
  %w(Helper\ tests      test/helpers),
  %w(Job\ tests         test/jobs),
  %w(Model\ tests       test/models),
  %w(Mailer\ tests      test/mailers),
  %w(Mailbox\ tests     test/mailboxes),
  %w(Channel\ tests     test/channels),
  %w(Integration\ tests test/integration),
  %w(System\ tests      test/system),
]

EXTENSIONS =
# File 'railties/lib/rails/code_statistics.rb', line 45
```
%w[rb js ts css scss coffee rake erb]
```

HEADERS =
# File 'railties/lib/rails/code_statistics.rb', line 43

{ lines: " Lines", code_lines: "   LOC", classes: "Classes", methods: "Methods" }

PATTERN =
# File 'railties/lib/rails/code_statistics.rb', line 47
```
/^(?!\.).*?\.(#{EXTENSIONS.join("|")})$/
```

TEST_TYPES =
# File 'railties/lib/rails/code_statistics.rb', line 33

["Controller tests",
"Helper tests",
"Model tests",
"Mailer tests",
"Mailbox tests",
"Channel tests",
"Job tests",
"Integration tests",
"System tests"]

Class Method Summary

.new(*pairs) ⇒ CodeStatistics constructor
.register_directory(label, path, test_directory: false)

Add directories to the output of the bin/rails stats command.
.register_extension(extension)

Add extensions to the output of the bin/rails stats command.

Instance Attribute Summary

#directories rw
#directories? ⇒ Boolean rw
#extensions rw
#extensions? ⇒ Boolean rw
#pattern rw
#pattern? ⇒ Boolean rw
#test_types rw
#test_types? ⇒ Boolean rw

Instance Method Summary

#to_s
#calculate_code private
#calculate_directory_statistics(directory, pattern = self.class.pattern) private
#calculate_statistics private
#calculate_tests private
#calculate_total private
#print_code_test_stats private
#print_header private
#print_line(name, statistics) private
#print_splitter private
#width_for(label) private

Constructor Details

.new(*pairs) ⇒ `CodeStatistics`

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 74


def initialize(*pairs)
  @pairs      = pairs
  @statistics = calculate_statistics
  @total      = calculate_total if pairs.length > 1
end

Class Attribute Details

.directories (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 49


class_attribute :directories, default: DIRECTORIES

.directories? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 49


class_attribute :directories, default: DIRECTORIES

.extensions (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 51


class_attribute :extensions, default: EXTENSIONS

.extensions? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 51


class_attribute :extensions, default: EXTENSIONS

.pattern (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 52


class_attribute :pattern, default: PATTERN

.pattern? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 52


class_attribute :pattern, default: PATTERN

.test_types (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 50


class_attribute :test_types, default: TEST_TYPES

.test_types? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 50


class_attribute :test_types, default: TEST_TYPES

Class Method Details

.register_directory(label, path, test_directory: false)

Add directories to the output of the bin/rails stats command.

Rails::CodeStatistics.register_directory("My Directory", "path/to/dir")

For directories that contain test code, set the test_directory argument to true.

Rails::CodeStatistics.register_directory("Model specs", "spec/models", test_directory: true)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 61


def self.register_directory(label, path, test_directory: false)
  self.directories << [label, path]
  self.test_types << label if test_directory
end

.register_extension(extension)

Add extensions to the output of the bin/rails stats command.

Rails::CodeStatistics.register_extension("txt")

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 69


def self.register_extension(extension)
  self.extensions += [extension]
  self.pattern = /^(?!\.).*?\.(#{Regexp.union(extensions.map { |e| Regexp.escape(e) })})$/
end

Instance Attribute Details

#directories (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 49


class_attribute :directories, default: DIRECTORIES

#directories? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 49


class_attribute :directories, default: DIRECTORIES

#extensions (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 51


class_attribute :extensions, default: EXTENSIONS

#extensions? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 51


class_attribute :extensions, default: EXTENSIONS

#pattern (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 52


class_attribute :pattern, default: PATTERN

#pattern? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 52


class_attribute :pattern, default: PATTERN

#test_types (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 50


class_attribute :test_types, default: TEST_TYPES

#test_types? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 50


class_attribute :test_types, default: TEST_TYPES

Instance Method Details

#calculate_code (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 120


def calculate_code
  code_loc = 0
  @statistics.each { |k, v| code_loc += v.code_lines unless test_types.include? k }
  code_loc
end

#calculate_directory_statistics(directory, pattern = self.class.pattern) (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 98


def calculate_directory_statistics(directory, pattern = self.class.pattern)
  stats = Rails::CodeStatisticsCalculator.new

  Dir.foreach(directory) do |file_name|
    path = "#{directory}/#{file_name}"

    if File.directory?(path) && !file_name.start_with?(".")
      stats.add(calculate_directory_statistics(path, pattern))
    elsif file_name&.match?(pattern)
      stats.add_by_file_path(path)
    end
  end

  stats
end

#calculate_statistics (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 94


def calculate_statistics
  Hash[@pairs.map { |pair| [pair.first, calculate_directory_statistics(pair.last)] }]
end

#calculate_tests (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 126


def calculate_tests
  test_loc = 0
  @statistics.each { |k, v| test_loc += v.code_lines if test_types.include? k }
  test_loc
end

#calculate_total (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 114


def calculate_total
  @statistics.each_with_object(Rails::CodeStatisticsCalculator.new) do |pair, total|
    total.add(pair.last)
  end
end

#print_code_test_stats (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 165


def print_code_test_stats
  code  = calculate_code
  tests = calculate_tests

  puts "  Code LOC: #{code}     Test LOC: #{tests}     Code to Test Ratio: 1:#{sprintf("%.1f", tests.to_f / code)}"
  puts ""
end

#print_header (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 136


def print_header
  print_splitter
  print "| Name                "
  HEADERS.each do |k, v|
    print " | #{v.rjust(width_for(k))}"
  end
  puts " | M/C | LOC/M |"
  print_splitter
end

#print_line(name, statistics) (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 154


def print_line(name, statistics)
  m_over_c   = (statistics.methods / statistics.classes) rescue 0
  loc_over_m = (statistics.code_lines / statistics.methods) - 2 rescue 0

  print "| #{name.ljust(20)} "
  HEADERS.each_key do |k|
    print "| #{statistics.send(k).to_s.rjust(width_for(k))} "
  end
  puts "| #{m_over_c.to_s.rjust(3)} | #{loc_over_m.to_s.rjust(5)} |"
end

#print_splitter (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 146


def print_splitter
  print "+----------------------"
  HEADERS.each_key do |k|
    print "+#{'-' * (width_for(k) + 2)}"
  end
  puts "------------+"
end

#to_s

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 80


def to_s
  print_header
  @pairs.each { |pair| print_line(pair.first, @statistics[pair.first]) }
  print_splitter

  if @total
    print_line("Total", @total)
    print_splitter
  end

  print_code_test_stats
end

#width_for(label) (private)

[ GitHub ]

# File 'railties/lib/rails/code_statistics.rb', line 132


def width_for(label)
  [@statistics.values.sum { |s| s.public_send(label) }.to_s.size, HEADERS[label].length].max
end

Class: Rails::CodeStatistics

Constant Summary

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(*pairs) ⇒ CodeStatistics

Class Attribute Details

.directories (rw)

.directories? ⇒ Boolean (rw)

.extensions (rw)

.extensions? ⇒ Boolean (rw)

.pattern (rw)

.pattern? ⇒ Boolean (rw)

.test_types (rw)

.test_types? ⇒ Boolean (rw)

Class Method Details

.register_directory(label, path, test_directory: false)

.register_extension(extension)

Instance Attribute Details

#directories (rw)

#directories? ⇒ Boolean (rw)

#extensions (rw)

#extensions? ⇒ Boolean (rw)

#pattern (rw)

#pattern? ⇒ Boolean (rw)

#test_types (rw)

#test_types? ⇒ Boolean (rw)

Instance Method Details

#calculate_code (private)

#calculate_directory_statistics(directory, pattern = self.class.pattern) (private)

#calculate_statistics (private)

#calculate_tests (private)

#calculate_total (private)

#print_code_test_stats (private)

#print_header (private)

#print_line(name, statistics) (private)

#print_splitter (private)

#to_s

#width_for(label) (private)

.new(*pairs) ⇒ `CodeStatistics`

.directories? ⇒ `Boolean` (rw)

.extensions? ⇒ `Boolean` (rw)

.pattern? ⇒ `Boolean` (rw)

.test_types? ⇒ `Boolean` (rw)

#directories? ⇒ `Boolean` (rw)

#extensions? ⇒ `Boolean` (rw)

#pattern? ⇒ `Boolean` (rw)

#test_types? ⇒ `Boolean` (rw)