bundler-stats 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fad76aec2c17866fce619ae8dbdaa4e580a58f1c0d89c53681a35dba5e266998
-  data.tar.gz: 27d5b7a9ac01d7f7c0856cd2422b127d18fcd4de1cda1b2bcb0bf5c596528ad6
+  metadata.gz: 8ecad684af63a04d936d307b3b165a0273b82ec21e7caab0b7473d2a3017fa35
+  data.tar.gz: f2564f384b1b5df0b3be76ad95b4cc67091f5f65b7d442c6f7ee0513ea14cc00
 SHA512:
-  metadata.gz: 57c12161cd51c19804cfd15fb17903c1a1a9a82fe1347cd303230f5979539c7306165b926d5db4e65434d43c19c9a8649afbe0c30ee58a41cfebc2cdc653b250
-  data.tar.gz: ee3ffeaa9580d4866a8fb11a947274ecd70e926cfdd3db83147a04500ab2a76e15ce89384268911e7e45587d483501d81d44d13e5733fe4c79f5746820887563
+  metadata.gz: c58e25a9360895d6727a46b7e0f4399b28bcc34d9eb5afd06db5f814511a69dfa0bfd4fec5383f769df987ab74fe8fc45b1514327468be1664f37d5f4c54e626
+  data.tar.gz: e2dbf4e320175d710add987c485f4e3491da9ff4d2d8ddee96328d0335444e312f88f2ab499f8b079828316a2254422a38465730587dd6a828f8498279a1a06d

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =============
 
+## [2.4.0] - 2023-07-01
+
+### Added
+- Make it possible to specify custom path for gem/Gemfile.
+
+## [2.3.0] - 2022-02-12
+
+### Added
+- Skiplist now correctly removes dependencies from 1st and onward levels
+- Wildcard ability for specifying gems for skiplist
+- Document `versions` in README
+
 ## [2.2.0] - 2022-02-09
 
 ### Added

data/README.md

@@ -34,8 +34,10 @@ Usage
         bundle-stats version          # Prints the bundler-stats version
         bundle-stats versions TARGET  # Shows versions requirements for target in other dependencies
 
+### Auditing Your Gemfile
+
 The most obvious thing to do is run the command by itself, which should help
-identify problem areas:
+identify problem areas.
 
     > bundle-stats
 
@@ -62,7 +64,7 @@ identify problem areas:
       Unpinned Versions   54
             Github Refs   0
 
-It looks like rails_admin is a huge problem. Use `show` to investigate:
+It looks like rails_admin is a huge problem. Use `show` to investigate.
 
     > bundle-stats show rails_admin
     bundle-stats for rails_admin
@@ -98,22 +100,117 @@ It looks like rails_admin is a huge problem. Use `show` to investigate:
     |                                | bundler                                |
     +--------------------------------|----------------------------------------+
 
-Removing the dep will only actually remove 9 gems. The rest are shared
-dependencies with other gems like rails. We can also omit trees we aren't going
-to remove (hi rails) by not following them:
+### Skipping Common Dependencies
+
+Let's take a look at another common gem to rails codebases. In this case,
+we have some unique dependencies, but also many dependencies on rails, and on
+its constituent gems.
+
+    > bundle-stats show compass-rails
+    bundle-stats for compass-rails
+
+    +--------------------------------|----------------------------------------+
+    |           Depended Upon By (0) |                                        |
+    |                Depends On (35) | compass, sass-rails, sprockets         |
+    |                                | chunky_png, compass-core               |
+    |                                | compass-import-once, rb-fsevent        |
+    |                                | rb-inotify, sass, multi_json, ffi      |
+    |                                | railties, sprockets-rails, tilt        |
+    |                                | actionpack, activesupport, method_source |
+    |                                | rake, thor, actionview, rack, rack-test |
+    |                                | rails-dom-testing, rails-html-sanitizer |
+    |                                | builder, erubi, concurrent-ruby, i18n  |
+    |                                | minitest, tzinfo, thread_safe, nokogiri |
+    |                                | mini_portile2, loofah, crass           |
+    |             Unique to This (3) | compass, compass-core                  |
+    |                                | compass-import-once                    |
+    +--------------------------------|----------------------------------------+
+
+We're not looking to remove rails, so there's not much point in including it
+within this output. Instead, we can use the `nofollow` flag to skip it in all
+output lists.
 
-    > bundle-stats show sass-rails --nofollow="railties,activesupport,actionpack"
-    bundle-stats for sass-rails
+    > bundle-stats show compass-rails --nofollow="railties,activeupport,actionview,actionpack"
+    bundle-stats for compass-rails
 
     +--------------------------------|----------------------------------------+
-    |           Depended Upon By (2) | compass-rails, rails_admin             |
-    |                 Depends On (9) | railties, sass, sprockets              |
+    |           Depended Upon By (0) |                                        |
+    |                Depends On (20) | compass, sass-rails, sprockets         |
+    |                                | chunky_png, compass-core               |
+    |                                | compass-import-once, rb-fsevent        |
+    |                                | rb-inotify, sass, multi_json, ffi      |
     |                                | sprockets-rails, tilt, concurrent-ruby |
-    |                                | rack, actionpack, activesupport        |
-    |             Unique to This (0) |                                        |
+    |                                | rack, activesupport, i18n, minitest    |
+    |                                | tzinfo, thread_safe                    |
+    |             Unique to This (3) | compass, compass-core                  |
+    |                                | compass-import-once                    |
     +--------------------------------|----------------------------------------+
 
-To consume information with a build job or somesuch, all commands can emit JSON:
+This is better, but for other codebases it's common for gems to depend on each
+of the _many many_ child gems of rails individually. Rather than specifying each
+by itself, we can use wildcards to remove them in bulk.
+
+    > bundle-stats show compass-rails --nofollow="rail*,action*,active*"
+    bundle-stats for compass-rails
+
+    +--------------------------------|----------------------------------------+
+    |           Depended Upon By (0) |                                        |
+    |                Depends On (15) | compass, sass-rails, sprockets         |
+    |                                | chunky_png, compass-core               |
+    |                                | compass-import-once, rb-fsevent        |
+    |                                | rb-inotify, sass, multi_json, ffi      |
+    |                                | sprockets-rails, tilt, concurrent-ruby |
+    |                                | rack                                   |
+    |             Unique to This (3) | compass, compass-core                  |
+    |                                | compass-import-once                    |
+    +--------------------------------|----------------------------------------+
+
+### Showing Required Versions
+
+Sometimes you try to upgrade a gem, you ask bundler _very nicely_, but you
+find that the version hasn't changed. When that happens, sometimes it's not
+clear why the gem version isn't changing.
+
+In that case, use `versions` to list all required dependencies on your gem.
+
+    > bundle-stats versions actionpack
+    version dependencies for actionpack
+
+    Depended Upon By   24
+    Resolved Version   5.2.0
+
+    +----------------------------|------------------+
+    |                       Name | Required Version |
+    +----------------------------|------------------+
+    |                  webpacker | = 5.2.0          |
+    |               actionmailer | = 5.2.0          |
+    |              activestorage | = 5.2.0          |
+    |               coffee-rails | = 5.2.0          |
+    |              compass-rails | = 5.2.0          |
+    |                     devise | = 5.2.0          |
+    |          factory_bot_rails | = 5.2.0          |
+    |         font-awesome-rails | = 5.2.0          |
+    |                rails_admin | = 5.2.0          |
+    |                   railties | = 5.2.0          |
+    |                 sass-rails | = 5.2.0          |
+    |                     scenic | = 5.2.0          |
+    |                 versionist | = 5.2.0          |
+    |                actioncable | = 5.2.0          |
+    |               jquery-rails | = 5.2.0          |
+    |            jquery-ui-rails | = 5.2.0          |
+    | jquery_file_download-rails | = 5.2.0          |
+    |                      rails | = 5.2.0          |
+    |                rspec-rails | >= 3.0           |
+    |            sprockets-rails | >= 4.0           |
+    |                 haml-rails | >= 4.0.1         |
+    |                 responders | >= 4.2.0, < 5.3  |
+    |                simple_form | >= 5.0           |
+    |   rails-controller-testing | ~> 5.x, >= 5.0.1 |
+    +----------------------------|------------------+
+
+### Output Formats
+
+To consume information with a build job or somesuch, all commands can emit JSON.
 
     > bundle-stats show sass-rails --nofollow="railties,activesupport,actionpack" -f json
     {
@@ -140,6 +237,14 @@ To consume information with a build job or somesuch, all commands can emit JSON:
       ]
     }
 
+### Custom Gemfile path
+
+This gem by default attempts to locate the Gemfile and Gemfile.lock files in parent directories. If you want to specify a specific location for your Gemfile/gems.rb file, you can use the `--gemfile_path` option.
+
+    > bundle-stats show sass-rails --gemfile_path=/Users/user/project/Gemfile
+
+Keep in mind that the location of the Gemfile.lock/gems.locked file will be inferred from the location of the Gemfile/gems.rb file.
+
 Contributing
 ------------
 

data/lib/bundler/stats/calculator.rb

@@ -5,7 +5,7 @@ module Bundler
     class Calculator
       attr_reader :parser, :tree, :gemfile, :remover
 
-      def initialize(gemfile_path, lockfile_path, options = {})
+      def initialize(gemfile_path, lockfile_path, skiplist = nil)
         raise ArgumentError unless File.readable?(lockfile_path)
         raise ArgumentError unless File.readable?(gemfile_path)
 
@@ -17,9 +17,7 @@ module Bundler
         lock_contents = File.read(lockfile_path)
         @parser = Bundler::LockfileParser.new(lock_contents)
 
-        skiplist = options.fetch(:skiplist, [])
         @tree = Bundler::Stats::Tree.new(@parser, skiplist: skiplist)
-
         @remover = Bundler::Stats::Remover.new(@tree, @gemfile)
       end
 

data/lib/bundler/stats/cli.rb

@@ -13,6 +13,7 @@ module Bundler
       desc 'stats', 'Displays basic stats about the gems in your Gemfile'
       method_option :format, aliases: "-f", description: "Output format, either JSON or text"
       method_option :nofollow, description: "A comma delimited list of dependencies not to follow."
+      method_option :gemfile_path, description: "Custom path for Gemfile/gems.rb and Gemfile.lock/gems.locked"
       def stats
         calculator = build_calculator(options)
         stats = calculator.stats
@@ -27,6 +28,7 @@ module Bundler
       desc 'show TARGET', 'Prints the dependency tree for a single gem in your Gemfile'
       method_option :format, aliases: "-f", description: "Output format, either JSON or text"
       method_option :nofollow, description: "A comma delimited list of dependencies not to follow."
+      method_option :gemfile_path, description: "Custom path for Gemfile/gems.rb and Gemfile.lock/gems.locked"
       def show(target)
         calculator = build_calculator(options)
         stats = calculator.summarize(target)
@@ -41,6 +43,7 @@ module Bundler
       desc 'versions TARGET', 'Shows versions requirements for target in other dependencies'
       method_option :format, aliases: "-f", description: "Output format, either JSON or text"
       method_option :nofollow, description: "A comma delimited list of dependencies not to follow."
+      method_option :gemfile_path, description: "Custom path for Gemfile/gems.rb and Gemfile.lock/gems.locked"
       def versions(target)
         calculator = build_calculator(options)
         stats = calculator.versions(target)
@@ -99,7 +102,7 @@ module Bundler
 
       def draw_versions(stats, target)
         dependers = stats[:top_level_dependencies] # they do the depending
-        say "bundle-stats for #{target}"
+        say "version dependencies for #{target}"
         say Printer.new(
           headers: nil,
           borders: false,
@@ -121,35 +124,16 @@ module Bundler
       end
 
       def build_calculator(options)
-        if !options[:nofollow].nil?
-          skiplist = options[:nofollow].gsub(/\s+/, '').split(",")
-        else
-          skiplist = []
-        end
-
-        @calculator ||= Bundler::Stats::Calculator.new(gemfile_path, lockfile_path, skiplist: skiplist)
+        skiplist = Bundler::Stats::Skiplist.new(options[:nofollow])
+        @calculator ||= Bundler::Stats::Calculator.new(
+          file_path_resolver.gemfile_path,
+          file_path_resolver.lockfile_path,
+          skiplist
+        )
       end
 
-      def gemfile_path
-        cwd = Pathname.new("./")
-        until cwd.realdirpath.root? do
-          %w(gems.rb Gemfile).each do |gemfile|
-            return (cwd + gemfile) if File.exist?(cwd + gemfile)
-          end
-          cwd = cwd.parent
-        end
-        raise ArgumentError, "Couldn't find gems.rb nor Gemfile in this directory or parents"
-      end
-
-      def lockfile_path
-        cwd = Pathname.new(".")
-        until cwd.realdirpath.root? do
-          %w(gems.locked Gemfile.lock).each do |lockfile|
-            return (cwd + lockfile) if File.exist?(cwd + lockfile)
-          end
-          cwd = cwd.parent
-        end
-        raise ArgumentError, "Couldn't find gems.locked nor Gemfile.lock in this directory or parents"
+      def file_path_resolver
+        @file_path_resolver ||= Bundler::Stats::FilePathResolver.new(options[:gemfile_path])
       end
     end
   end

data/lib/bundler/stats/file_path_resolver.rb

@@ -0,0 +1,56 @@
+module Bundler
+  module Stats
+    class FilePathResolver
+      FILES_MAP = {
+        "gems.rb" => "gems.locked",
+        "Gemfile" => "Gemfile.lock"
+      }
+
+      def initialize(specific_gemfile_path = nil)
+        @specific_gemfile_path = specific_gemfile_path
+      end
+
+      def gemfile_path
+        resolve_file_path(FILES_MAP.keys, specific_gemfile_path)
+      end
+
+      def lockfile_path
+        resolve_file_path(FILES_MAP.values, resolve_lockfile_path)
+      end
+
+      private
+
+      attr_reader :specific_gemfile_path
+
+      def resolve_lockfile_path
+        return unless specific_gemfile_path
+
+        file_path = Pathname.new(specific_gemfile_path)
+        file_name = file_path.basename.to_s
+        locked_file_name = FILES_MAP[file_name]
+        raise ArgumentError, "Invalid file name: #{file_name}" if locked_file_name.nil?
+        file_path.dirname.join(locked_file_name).to_s
+      end
+
+      def resolve_file_path(file_names, custom_path)
+        if custom_path
+          raise ArgumentError, "Couldn't find #{custom_path} file path" unless File.exist?(custom_path)
+          return custom_path
+        end
+
+        find_file_path(file_names)
+      end
+
+      def find_file_path(file_names)
+        cwd = Pathname.new(".")
+        until cwd.realdirpath.root? do
+          file_names.each do |file|
+            return (cwd + file).to_s if File.exist?(cwd + file)
+          end
+          cwd = cwd.parent
+        end
+        raise ArgumentError, "Couldn't find #{file_names.join(" nor ")} in this directory or parents"
+      end
+    end
+  end
+end

data/lib/bundler/stats/skiplist.rb

@@ -0,0 +1,32 @@
+class Bundler::Stats::Skiplist
+  attr_reader :regex_list
+
+  def initialize(list = '')
+    @regex_list = if list.respond_to?(:regex_list)
+      list.regex_list
+    elsif list.respond_to?(:split)
+      list
+        .gsub(/\s+/, '')
+        .split(",")
+        .map { |str| glob_to_regex(str) }
+    else
+      (list || []).map { |str| glob_to_regex(str) }
+    end
+  end
+
+  def filter(gem_list)
+    gem_list.reject { |gem| self.include?(gem) }
+  end
+
+  def include?(target)
+    @regex_list.any? { |pattern| pattern =~ target.name }
+  end
+
+  private
+
+  def glob_to_regex(str)
+    str.gsub!('*','.*') # weird globbish behavior
+
+    /^#{str}$/
+  end
+end

data/lib/bundler/stats/tree.rb

@@ -1,20 +1,21 @@
 class Bundler::Stats::Tree
-  attr_accessor :tree
+  attr_accessor :tree, :skiplist
 
   ERR_MESSAGE = "The dependency `%s` wasn't found. It may not be present in " \
                 "your Gemfile.lock. This often happens when a dependency isn't " \
                 "installed on your platform."
 
-  def initialize(parser, skiplist: [])
+  def initialize(parser, skiplist: '')
     raise ArgumentError unless parser.respond_to?(:specs)
 
     @parser   = parser
     @tree     = specs_as_tree(@parser.specs)
-    @skiplist = skiplist
+    @skiplist = Bundler::Stats::Skiplist.new(skiplist)
   end
 
   def summarize(target)
     transitive_dependencies = transitive_dependencies(target)
+
     { name: target,
       total_dependencies: transitive_dependencies.count,
       first_level_dependencies: first_level_dependencies(target).count,
@@ -51,12 +52,12 @@ class Bundler::Stats::Tree
       return []
     end
 
-    top_level = @tree[target].dependencies
+    top_level = skiplist.filter(@tree[target].dependencies)
     all_level = top_level + top_level.inject([]) do |arr, dep|
       # turns out bundler refuses to include itself in the dependency tree,
       # which is sneaky
       next arr if dep.name == "bundler"
-      next arr if @skiplist.include? dep.name
+      next arr if skiplist.include? dep
 
       arr += transitive_dependencies(dep.name)
     end

data/lib/bundler/stats/version.rb

@@ -1,5 +1,5 @@
 module Bundler
   module Stats
-    VERSION = '2.2.0'
+    VERSION = '2.4.0'
   end
 end

data/lib/bundler/stats.rb

@@ -1,5 +1,7 @@
 require_relative 'stats/calculator'
+require_relative 'stats/file_path_resolver'
 require_relative 'stats/printer'
 require_relative 'stats/remover'
+require_relative 'stats/skiplist'
 require_relative 'stats/tree'
 require_relative 'stats/version'

data/spec/lib/bundler/stats/calculator_spec.rb

@@ -38,9 +38,9 @@ describe Bundler::Stats::Calculator do
       # this sucks. break this dependency further
       allow(Bundler::LockfileParser).to receive(:new) { "parser" }
 
-      target = subject.new(gemfile_path, lockfile_path, skiplist: "abc")
+      target = subject.new(gemfile_path, lockfile_path, "skiplist")
 
-      expect(Bundler::Stats::Tree).to have_received(:new).with("parser", skiplist: "abc")
+      expect(Bundler::Stats::Tree).to have_received(:new).with("parser", skiplist: "skiplist")
     end
   end
 

data/spec/lib/bundler/stats/file_path_resolver_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Bundler::Stats::FilePathResolver do
+  let(:file_path_resolver) { described_class.new(specific_gemfile_path) }
+
+  context "with undefined specific gemfile path" do
+    let(:specific_gemfile_path) { nil }
+
+    before do
+      allow(File).to receive(:exist?).and_return(false)
+    end
+
+    context "without files found" do
+      it do
+        expect { file_path_resolver.gemfile_path }.to raise_error(
+          ArgumentError, "Couldn't find gems.rb nor Gemfile in this directory or parents"
+        )
+      end
+
+      it do
+        expect { file_path_resolver.lockfile_path }.to raise_error(
+          ArgumentError, "Couldn't find gems.locked nor Gemfile.lock in this directory or parents"
+        )
+      end
+    end
+
+    context "with files found" do
+      before do
+        allow(File).to receive(:exist?).with(Pathname.new("../Gemfile")).and_return(true)
+        allow(File).to receive(:exist?).with(Pathname.new("../../gems.locked")).and_return(true)
+      end
+
+      it { expect(file_path_resolver.gemfile_path).to eq("../Gemfile") }
+      it { expect(file_path_resolver.lockfile_path).to eq("../../gems.locked") }
+    end
+  end
+
+  context "with specific gemfile path" do
+    let(:specific_gemfile_path) { "some-project/Gemfile" }
+
+    context "with valid file path" do
+      before do
+        allow(File).to receive(:exist?).and_return(true)
+      end
+
+      it { expect(file_path_resolver.gemfile_path).to eq("some-project/Gemfile") }
+      it { expect(file_path_resolver.lockfile_path).to eq("some-project/Gemfile.lock") }
+
+      context "with gems.rb file" do
+        let(:specific_gemfile_path) { "some-project/gems.rb" }
+
+        it { expect(file_path_resolver.gemfile_path).to eq("some-project/gems.rb") }
+        it { expect(file_path_resolver.lockfile_path).to eq("some-project/gems.locked") }
+      end
+
+      context "with invalid file name" do
+        let(:specific_gemfile_path) { "some-project/yeimfile" }
+
+        it do
+          expect { file_path_resolver.lockfile_path }.to raise_error(
+            ArgumentError, "Invalid file name: yeimfile"
+          )
+        end
+      end
+    end
+
+    context "with invalid file path" do
+      before do
+        allow(File).to receive(:exist?).and_return(false)
+      end
+
+      it do
+        expect { file_path_resolver.gemfile_path }.to raise_error(
+          ArgumentError, "Couldn't find some-project/Gemfile file path"
+        )
+      end
+
+      it do
+        expect { file_path_resolver.lockfile_path }.to raise_error(
+          ArgumentError, "Couldn't find some-project/Gemfile.lock file path"
+        )
+      end
+    end
+  end
+end

data/spec/lib/bundler/stats/tree_spec.rb

@@ -140,20 +140,24 @@ describe Bundler::Stats::Tree do
   end
 
   context "skip lists" do
-    it "still includes the skipped entry" do
+    it "skips processing the requested entry, plus children of skipped entries" do
       tree = subject.new(parser, skiplist: ["depth-three"])
 
       target = tree.transitive_dependencies("depth-one")
 
-      expect(target.map(&:name)).to include("depth-three")
+      expect(target.map(&:name)).to include("depth-two")
+      expect(target.map(&:name)).not_to include("depth-three")
+      expect(target.map(&:name)).not_to include("depth-four")
     end
 
-    it "stops processing the children of skipped entries" do
-      tree = subject.new(parser, skiplist: ["depth-three"])
+    it "allows skiplist wildcards" do
+      tree = subject.new(parser, skiplist: ["depth-t*"])
 
       target = tree.transitive_dependencies("depth-one")
 
-      expect(target.map(&:name)).not_to include("depth-four")
+      expect(target.map(&:name)).not_to include("depth-two")
+      expect(target.map(&:name)).not_to include("depth-three")
+      expect(target.map(&:name)).not_to include("depth-four") # because transitive
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-stats
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Joseph Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2023-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,11 +148,14 @@ files:
 - lib/bundler/stats.rb
 - lib/bundler/stats/calculator.rb
 - lib/bundler/stats/cli.rb
+- lib/bundler/stats/file_path_resolver.rb
 - lib/bundler/stats/printer.rb
 - lib/bundler/stats/remover.rb
+- lib/bundler/stats/skiplist.rb
 - lib/bundler/stats/tree.rb
 - lib/bundler/stats/version.rb
 - spec/lib/bundler/stats/calculator_spec.rb
+- spec/lib/bundler/stats/file_path_resolver_spec.rb
 - spec/lib/bundler/stats/printer_spec.rb
 - spec/lib/bundler/stats/remover_spec.rb
 - spec/lib/bundler/stats/tree_spec.rb