bundler-stats 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38f866872f6ba724ee82db46ba1715c05bcf8f22272f0ae6a23a96b1760232ce
-  data.tar.gz: ee9b4655d4c8faa1da7f23d3602820ab70eeaf10aad836f4bc7c544cd10bf795
+  metadata.gz: 8ecad684af63a04d936d307b3b165a0273b82ec21e7caab0b7473d2a3017fa35
+  data.tar.gz: f2564f384b1b5df0b3be76ad95b4cc67091f5f65b7d442c6f7ee0513ea14cc00
 SHA512:
-  metadata.gz: e31cce716bfae8bdc92e525d1047678b96c4ea18f80aee2875718f84c690a8a76dbd34ee923b445724716f45eb0e9cdbeab69e13b0d6479284cb4a1185beeecf
-  data.tar.gz: 2644320effea69f6e117a92154e3ddf0e0a3327a23d8141262dc4138fefa8a8a84eab049e68686ded2f778d2b271cbf8a00c43a6eb2b9fa06c09d01b11ce694d
+  metadata.gz: c58e25a9360895d6727a46b7e0f4399b28bcc34d9eb5afd06db5f814511a69dfa0bfd4fec5383f769df987ab74fe8fc45b1514327468be1664f37d5f4c54e626
+  data.tar.gz: e2dbf4e320175d710add987c485f4e3491da9ff4d2d8ddee96328d0335444e312f88f2ab499f8b079828316a2254422a38465730587dd6a828f8498279a1a06d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 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

data/README.md

@@ -237,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/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)
@@ -122,29 +125,15 @@ module Bundler
 
       def build_calculator(options)
         skiplist = Bundler::Stats::Skiplist.new(options[:nofollow])
-        @calculator ||= Bundler::Stats::Calculator.new(gemfile_path, lockfile_path, skiplist)
+        @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/version.rb

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

data/lib/bundler/stats.rb

@@ -1,4 +1,5 @@
 require_relative 'stats/calculator'
+require_relative 'stats/file_path_resolver'
 require_relative 'stats/printer'
 require_relative 'stats/remover'
 require_relative 'stats/skiplist'

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-stats
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Joseph Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2023-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,12 +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