show-gem-junk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0f1225fea896e47483ceb42cd59b59df1db5dcd59548f4293a7af898ae7b4b4
+  data.tar.gz: bbe45d627b5487ab7b0339e253ba2b3a968419681bc146363866d8a36ca92373
+SHA512:
+  metadata.gz: 42d1496c62aacfd31f426d04e8b5fb1010c20acb22ca9fbe09e96ff0bd14ba95b3eb1e133f5748df0d99ebc2fa0a347b415f653e78eced2e725bd651e20c92f3
+  data.tar.gz: eaf85724deeb6afd15b8557ab9e7a872c67f49108f60aaa37faa0550705310abc970253a2ce5c5c59155ef999bb1d14ea8a4783efae660a42e3d38f554748eee

data/exe/show-gem-junk

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'show/gem/junk'
+require 'active_support'
+require 'active_support/core_ext/numeric/conversions'
+require 'colorator'
+require 'optparse'
+
+HOME_DIR = ENV.fetch('HOME', '~')
+COL_WIDTH = 10
+
+def try_fetch_gem_home
+  ENV.fetch('GEM_HOME')
+rescue KeyError
+  export_line = "export GEM_HOME=#{HOME_DIR}/.gem/ruby/2.6.0".red.bold
+  warn <<-MSG
+  #{'ERROR:'.red.bold}
+    This tool requires the $GEM_HOME environment variable to be set.
+    You do not have a value for $GEM_HOME.
+
+    Before running this tool, please set your $GEM_HOME.
+    For example:
+
+      #{export_line}
+
+  MSG
+  exit 1
+end
+
+GEMS_DIR = File.join(try_fetch_gem_home, '/gems/')
+
+def main
+  # Parse options
+  options = {}
+  OptionParser.new do |opts|
+    opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+
+    opts.on('-v', '--[no-]verbose', 'Print verbose list of files') do |v|
+      options[:verbose] = v
+    end
+  end.parse!
+
+  # Collect gems
+  gems = Dir.glob(GEMS_DIR + '*').map do |gem|
+    Show::Gem::Junk::RubyGem.new(gem)
+  end
+  gems = gems.reject { |g| g.junk_files.empty? }.sort.reverse
+
+  # Print results
+  if options[:verbose]
+    print_verbose(gems)
+  else
+    print_table(gems)
+  end
+
+  print_total(gems)
+end
+
+def print_table(gems)
+  max_gem_name_len = gems.map { |g| g.name.size }.max || 0
+
+  # Header
+  puts
+  puts [
+    'Gem Name'.ljust(max_gem_name_len),
+    'Version'.rjust(COL_WIDTH),
+    'Size'.rjust(COL_WIDTH),
+    'Junk'.rjust(COL_WIDTH),
+    '% Junk'.rjust(COL_WIDTH)
+  ].join(' ').bold
+
+  # Rows
+  gems.each do |gem|
+    puts [
+      gem.name.ljust(max_gem_name_len),
+      gem.version.rjust(COL_WIDTH),
+      gem.size.to_s(:human_size).rjust(COL_WIDTH),
+      gem.junk_size.to_s(:human_size).rjust(COL_WIDTH),
+      gem.percent_junk.round(2).to_s.rjust(COL_WIDTH)
+    ].join(' ')
+  end
+end
+
+def print_verbose(gems)
+  gems.each do |gem|
+    puts
+    puts 'Gem Name: '.bold + gem.name
+    puts 'Version:  '.bold + gem.version
+    puts 'Path:     '.bold + gem.path
+    puts 'Size:     '.bold + gem.size.to_s(:human_size)
+    puts 'Junk:     '.bold + gem.junk_size.to_s(:human_size)
+    puts '% Junk:   '.bold + gem.percent_junk.round(2).to_s
+    puts
+
+    max_junk_name_len = gem.junk_files.map { |g| g.pretty_path.size }.max || 0
+    puts [
+      'Junk File'.ljust(max_junk_name_len),
+      'Size'.rjust(COL_WIDTH)
+    ].join(' ').bold
+
+    gem.junk_files.sort.reverse.each do |file|
+      puts [
+        file.pretty_path.ljust(max_junk_name_len),
+        file.size.to_s(:human_size).rjust(COL_WIDTH)
+      ].join(' ')
+    end
+    puts
+    puts '=' * 80
+  end
+end
+
+def print_total(gems)
+  total_junk = gems.map(&:junk_size).sum
+  puts
+  puts "Grand total size of junk: #{total_junk.to_s(:human_size)}"
+end
+
+main

data/lib/show/gem/junk.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'show/gem/junk/version'
+
+module Show
+  module Gem
+    module Junk
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end
+
+require 'show/gem/junk/rubygem'
+require 'show/gem/junk/gemfile'

data/lib/show/gem/junk/gemfile.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+# GemFile is a file that belongs to a rubygem
+class Show::Gem::Junk::GemFile
+  attr_accessor :path, :stat
+
+  def initialize(path)
+    @path = path
+    @stat = File.stat(path)
+  end
+
+  def size
+    stat.size
+  end
+
+  def pretty_path
+    path.gsub(GEMS_DIR, '')
+  end
+
+  def <=>(other)
+    size <=> other.size
+  end
+
+  def junk?
+    return false if File.directory?(path)
+
+    basename = File.basename(path)
+
+    # Files
+    return true if basename.end_with?('.gemspec')
+    return true if basename == '.gitignore'
+    return true if basename == '.travis.yml'
+    return true if basename == '.appveyor.yml'
+
+    # Loose path matching
+    return true if path.include?('concourse')
+
+    # Specs
+    parts = Pathname.new(pretty_path).each_filename.to_a
+    return false if parts.size < 2
+    return true if parts[1] == 'test'
+    return true if parts[1] == 'spec'
+    return true if parts[1] == 'features'
+
+    false
+  end
+end

data/lib/show/gem/junk/rubygem.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# RubyGem is an unpacked gem on disk
+class Show::Gem::Junk::RubyGem
+  attr_accessor :name, :path, :version, :files
+
+  def initialize(path)
+    @path = File.expand_path(path)
+    @name, _, @version = path.gsub(GEMS_DIR, '').rpartition('-')
+    @files = Dir.glob("#{GEMS_DIR}#{name}-#{version}/**/*", File::FNM_DOTMATCH).map do |f|
+      Show::Gem::Junk::GemFile.new(f)
+    end
+  end
+
+  def junk_files
+    files.select(&:junk?)
+  end
+
+  def size
+    files.map(&:size).sum
+  end
+
+  def junk_size
+    junk_files.map(&:size).sum
+  end
+
+  def percent_junk
+    return 0.0 if size.zero?
+
+    (junk_size.to_f / size) * 100
+  end
+
+  def <=>(other)
+    percent_junk <=> other.percent_junk
+  end
+end

data/lib/show/gem/junk/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Show
+  module Gem
+    module Junk
+      VERSION = '1.0.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: show-gem-junk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tom Richards
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Analyzes gems and shows a table of junk by percentage.
+email:
+- tom@tomrichards.net
+executables:
+- show-gem-junk
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/show-gem-junk
+- lib/show/gem/junk.rb
+- lib/show/gem/junk/gemfile.rb
+- lib/show/gem/junk/rubygem.rb
+- lib/show/gem/junk/version.rb
+homepage: https://github.com/t-richards/show-gem-junk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/t-richards/show-gem-junk
+  source_code_uri: https://github.com/t-richards/show-gem-junk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: A tool for analyzing junk contained within your GEM_HOME
+test_files: []