devpack 0.3.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e708e92800fdb16f17e5f15decb2d89fd935ea0c2b473f243fa78b472f571f6
-  data.tar.gz: 24924053b2ee1c90ebc75e5eb0a8f7ee45d7196c63a059da761f68da5c0f1ee5
+  metadata.gz: bc62279883bef6f044e47c419b853c89b33e76f699d7106575cd87869967b36d
+  data.tar.gz: 48a959cbd1004dce6752b6fb723905ad40f92c02cf73cd8432b969309d94f5a8
 SHA512:
-  metadata.gz: 935db175be08d441d07fb6ad177e2bfa80b971dad327f6f0d3f761f4507a00883bae57414c20bebf19451bef5318aecc3a1d93d0b0591c2fe06dd769b99f1514
-  data.tar.gz: '089ba6844efef952c3b2f72fbc27d6e87c770f29c6bc39f57e97f0a4000874ea380a829926297f846cdee386e4ab5e661a5dc98c4c02ca35408fbf4381d17948'
+  metadata.gz: a473937535208f922c6ceed0e137cfa758bf806bb39516e6f01906d748ef219c0fcb69fba33e195c49e95f045cf335267b7b997f300c30e6311792becba6a4ea
+  data.tar.gz: 5e4247975b02ec3432344755432bb887ca7036cdb9792a3c8377d3a091dc5c92a464e0e8cf5dcda82248f2039e4c6ca0efedacf4761bec870d0d2fe6101cd254

data/.rubocop.yml

@@ -6,3 +6,7 @@ AllCops:
   NewCops: enable
   Exclude:
   - "spec/fixtures/**/*"
+
+Bundler/GemFilename:
+  Exclude:
+  - "lib/devpack/gems.rb"

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.5.9

data/README.md

@@ -21,7 +21,7 @@ Add _Devpack_ to any project's `Gemfile`:
 ```ruby
 # Gemfile
 group :development, :test do
-  gem 'devpack', '~> 0.3.3'
+  gem 'devpack', '~> 0.4.0'
 end
 ```
 
@@ -45,6 +45,24 @@ It is recommended to use a [global configuration](#global-configuration).
 
 When using a per-project configuration, `.devpack` files should be added to `.gitignore`.
 
+### Gem Installation
+
+A convenience command is provided to install all gems listed in `.devpack` file that are not already installed:
+
+```bash
+bundle exec devpack install
+```
+
+### Executing Commands Provided by DevPack Gems
+
+Use the `exec` command to run a command provided by a gem installed via _Devpack_.
+
+An example use case of this is the [Guard](https://github.com/guard/guard) gem:
+
+```bash
+bundle exec devpack exec guard
+```
+
 ### Initializers
 
 Custom initializers can be loaded by creating a directory named `.devpack_initializers` containing a set of `.rb` files.
@@ -75,6 +93,13 @@ To configure globally simply save your `.devpack` configuration file to any pare
 
 This strategy also applies to `.devpack_initializers`.
 
+### Silencing
+
+To prevent _Devpack_ from displaying messages on load, set the environment variable `DEVPACK_SILENT=1` to any value:
+```bash
+DEVPACK_SILENT=1 bundle exec ruby myapp.rb
+```
+
 ### Disabling
 
 To disable _Devpack_ set the environment variable `DEVPACK_DISABLE` to any value:

data/devpack.gemspec

@@ -17,12 +17,13 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'bin'
-  spec.executables   = []
+  spec.bindir        = 'exe'
+  spec.executables   = ['devpack']
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'byebug', '~> 11.1'

data/exe/devpack

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+command = ARGV[0]
+
+ENV['DEVPACK_DISABLE'] = '1' if command == 'install'
+
+require 'open3'
+
+require 'devpack'
+
+case command
+when 'install'
+  require 'devpack/install'
+when 'exec'
+  require 'devpack/exec'
+else
+  warn "[devpack] Unknown command: #{command}"
+  exit 1
+end

data/lib/devpack/exec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+Gem.module_eval do
+  def self.devpack_bin_path(gem_name, command, _version = nil)
+    File.join(Gem.loaded_specs[gem_name].full_gem_path, Gem.loaded_specs[gem_name].bindir, command)
+  end
+
+  class << self
+    alias_method :_orig_activate_bin_path, :activate_bin_path
+    alias_method :_orig_bin_path, :bin_path
+
+    def activate_bin_path(*args)
+      _orig_activate_bin_path(*args)
+    rescue Gem::Exception
+      devpack_bin_path(*args)
+    end
+
+    def bin_path(*args)
+      _orig_bin_path(*args)
+    rescue Gem::Exception
+      devpack_bin_path(*args)
+    end
+  end
+end
+
+def devpack_exec(args)
+  options = Bundler::Thor::CoreExt::HashWithIndifferentAccess.new({ 'keep_file_descriptors' => true })
+  Bundler::CLI::Exec.new(options, args).run
+end
+
+devpack_exec(ARGV[1..-1])

data/lib/devpack/gem_glob.rb

@@ -44,8 +44,8 @@ module Devpack
     end
 
     def gem_path
-      return ENV['GEM_PATH'] if ENV.key?('GEM_PATH')
-      return ENV['GEM_HOME'] if ENV.key?('GEM_HOME')
+      return ENV.fetch('GEM_PATH', nil) if ENV.key?('GEM_PATH')
+      return ENV.fetch('GEM_HOME', nil) if ENV.key?('GEM_HOME')
 
       nil
     end

data/lib/devpack/gem_spec.rb

@@ -3,56 +3,104 @@
 module Devpack
   # Locates relevant gemspec for a given gem and provides a full list of paths
   # for all `require_paths` listed in gemspec.
+  # rubocop:disable Metrics/ClassLength
   class GemSpec
-    def initialize(glob, name, requirement)
+    attr_reader :name, :root
+
+    def initialize(glob, name, requirement, root: nil)
       @name = name
       @glob = glob
       @requirement = requirement
+      @root = root || self
       @dependency = Gem::Dependency.new(@name, @requirement)
     end
 
     def require_paths(visited = Set.new)
-      raise GemNotFoundError, @requirement.nil? ? '-' : required_version if gemspec.nil?
+      raise GemNotFoundError.new("Gem not found: #{required_version}", self) if gemspec.nil?
 
       (immediate_require_paths + dependency_require_paths(visited)).compact.flatten.uniq
     end
 
     def gemspec
+      return Gem.loaded_specs[@name] if compatible?(Gem.loaded_specs[@name])
+
       @gemspec ||= gemspecs.find do |spec|
         next false if spec.nil?
 
-        @dependency.requirement.satisfied_by?(spec.version) && compatible?(spec)
+        raise_incompatible(spec) unless compatible?(spec)
+
+        @dependency.requirement.satisfied_by?(spec.version)
       end
     end
 
+    def pretty_name
+      return @name.to_s if @requirement.nil?
+
+      "#{@name} #{@requirement}"
+    end
+
+    def root?
+      self == @root
+    end
+
+    def required_version
+      return @name.to_s if compatible_spec.nil? && @requirement.nil?
+      return "#{@name}:#{compatible_version}" if compatible_spec.nil?
+
+      "#{@name}:#{compatible_spec.version}"
+    end
+
     private
 
     def compatible?(spec)
       return false if spec.nil?
       return false if incompatible_version_loaded?(spec)
 
-      compatible_specs?(Gem.loaded_specs.values, [@dependency] + spec.runtime_dependencies)
+      compatible_specs?([@dependency] + spec.runtime_dependencies)
+    end
+
+    def compatible_spec
+      @compatible_spec ||= gemspecs.compact
+                                   .select { |spec| requirements_satisfied_by?(spec.version) }
+                                   .max_by(&:version)
     end
 
     def incompatible_version_loaded?(spec)
       matched = Gem.loaded_specs[spec.name]
       return false if matched.nil?
 
-      matched.version != spec.version
+      !matched.satisfies_requirement?(@dependency)
     end
 
-    def required_version
-      @requirement.requirements.first.last.version
+    def raise_incompatible(spec)
+      raise GemIncompatibilityError.new('Incompatible dependencies', incompatible_dependencies(spec))
+    end
+
+    def compatible_version
+      @requirement.requirements.map(&:last).max_by { |version| @requirement.satisfied_by?(version) }
     end
 
-    def compatible_specs?(specs, dependencies)
-      specs.all? { |spec| compatible_dependencies?(dependencies, spec) }
+    def requirements_satisfied_by?(version)
+      @dependency.requirement.satisfied_by?(version)
+    end
+
+    def compatible_specs?(dependencies)
+      Gem.loaded_specs.values.all? { |spec| compatible_dependencies?(dependencies, spec) }
     end
 
     def compatible_dependencies?(dependencies, spec)
       dependencies.all? { |dependency| compatible_dependency?(dependency, spec) }
     end
 
+    def incompatible_dependencies(spec)
+      dependencies = [@dependency] + spec.runtime_dependencies
+      Gem.loaded_specs.map do |_name, loaded_spec|
+        next nil if compatible_dependencies?(dependencies, loaded_spec)
+
+        [@root, dependencies.reject { |dependency| compatible_dependency?(dependency, loaded_spec) }]
+      end.compact
+    end
+
     def compatible_dependency?(dependency, spec)
       return false if spec.nil?
       return true unless dependency.name == spec.name
@@ -69,7 +117,7 @@ module Devpack
         next nil if visited.include?(dependency)
 
         visited << dependency
-        GemSpec.new(@glob, dependency.name, dependency.requirement).require_paths(visited)
+        GemSpec.new(@glob, dependency.name, dependency.requirement, root: @root).require_paths(visited)
       end
     end
 
@@ -101,4 +149,5 @@ module Devpack
       @candidates ||= @glob.find(@name)
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/devpack/gems.rb

@@ -5,36 +5,38 @@ module Devpack
   class Gems
     include Timeable
 
+    attr_reader :missing
+
     def initialize(config, glob = GemGlob.new)
       @config = config
       @gem_glob = glob
       @failures = []
       @missing = []
+      @incompatible = []
     end
 
-    def load
+    def load(silent: false)
       return [] if @config.requested_gems.nil?
 
       gems, time = timed { load_devpack }
       names = gems.map(&:first)
-      summarize(gems, time)
+      summarize(gems, time) unless silent
       names
     end
 
     private
 
     def summarize(gems, time)
-      @failures.each do |failure|
-        warn(:error, Messages.failure(failure[:name], failure[:message]))
-      end
-      warn(:success, Messages.loaded(@config.devpack_path, gems, time.round(2)))
+      @failures.each { |failure| warn(:error, Messages.failure(failure[:name], failure[:message])) }
+      warn(:success, Messages.loaded(@config, gems, time.round(2)))
       warn(:info, Messages.install_missing(@missing)) unless @missing.empty?
+      warn(:info, Messages.alert_incompatible(@incompatible.flatten(1))) unless @incompatible.empty?
     end
 
     def load_devpack
       @config.requested_gems.map do |requested|
         name, _, version = requested.partition(':')
-        load_gem(name, version.empty? ? nil : Gem::Requirement.new("= #{version}"))
+        load_gem(name, version.empty? ? nil : Gem::Requirement.new(version))
       end.compact
     end
 
@@ -42,11 +44,11 @@ module Devpack
       [name, activate(name, requirement)]
     rescue LoadError => e
       deactivate(name)
-      @failures << { name: name, message: load_error_message(e) }
-      nil
+      nil.tap { @failures << { name: name, message: load_error_message(e) } }
     rescue GemNotFoundError => e
-      @missing << { name: name, version: e.message == '-' ? nil : e.message }
-      nil
+      nil.tap { @missing << e.meta }
+    rescue GemIncompatibilityError => e
+      nil.tap { @incompatible << e.meta }
     end
 
     def activate(name, version)
@@ -77,6 +79,7 @@ module Devpack
 
     def update_load_path(paths)
       $LOAD_PATH.concat(paths)
+      ENV['RUBYLIB'] = $LOAD_PATH.join(':')
     end
   end
 end

data/lib/devpack/install.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+missing = Devpack::Gems.new(Devpack.config).tap { |gems| gems.load(silent: true) }.missing
+install_command = "bundle exec gem install -V #{missing.map(&:required_version).join(' ')}" unless missing.empty?
+if install_command.nil?
+  Devpack.warn(:info, Devpack::Messages.no_gems_to_install)
+else
+  Devpack.warn(:info, install_command)
+  output, status = Open3.capture2e(install_command)
+  if status.success?
+    Devpack.warn(:success, 'Installation complete.')
+  else
+    Devpack.warn(:error, "Installation failed. Manually verify this command: #{install_command}")
+    puts output
+  end
+end
+exit 0

data/lib/devpack/messages.rb

@@ -13,24 +13,48 @@ module Devpack
         "Failed to load initializer `#{path}`: #{error_message}"
       end
 
-      def loaded(path, gems, time)
-        already_loaded = gems.size - gems.reject { |_, loaded| loaded }.size
-        base = "Loaded #{already_loaded} development gem(s) from '#{path}' in #{time} seconds"
-        return "#{base}." if already_loaded == gems.size
+      # rubocop:disable Metrics/AbcSize
+      def loaded(config, gems, time)
+        loaded = gems.size - gems.reject { |_, devpack_loaded| devpack_loaded }.size
+        of_total = gems.size == config.requested_gems.size ? nil : " of #{color(:cyan) { config.requested_gems.size }}"
+        path = color(:cyan) { config.devpack_path }
+        base = "Loaded #{color(:green) { loaded }}#{of_total} development gem(s) from #{path} in #{time} seconds"
+        return "#{base}." if loaded == gems.size
 
-        "#{base} (#{gems.size - already_loaded} gem(s) were already loaded by environment)."
+        "#{base} (#{color(:cyan) { gems.size - loaded }} gem(s) were already loaded by environment)."
       end
+      # rubocop:enable Metrics/AbcSize
 
       def loaded_initializers(path, initializers, time)
-        "Loaded #{initializers.compact.size} initializer(s) from '#{path}' in #{time} seconds"
+        "Loaded #{color(:green) { initializers.compact.size }} initializer(s) from '#{path}' in #{time} seconds"
       end
 
       def install_missing(missing)
-        gems = missing.map do |spec|
-          spec[:version].nil? ? spec[:name] : "#{spec[:name]}==#{spec[:version]}"
+        command = color(:cyan) { 'bundle exec devpack install' }
+        grouped_missing = missing
+                          .group_by(&:root)
+                          .map do |root, dependencies|
+          next (color(:cyan) { root.pretty_name }).to_s if dependencies.all?(&:root?)
+
+          formatted_dependencies = dependencies.map { |dependency| color(:yellow) { dependency.pretty_name } }
+          "#{color(:cyan) { root.pretty_name }}: #{formatted_dependencies.join(', ')}"
+        end
+        "Install #{missing.size} missing gem(s): #{command} # [#{grouped_missing.join(', ')}]"
+      end
+
+      def alert_incompatible(incompatible)
+        grouped_dependencies = {}
+        incompatible.each do |spec, dependencies|
+          key = spec.root.pretty_name
+          grouped_dependencies[key] ||= []
+          grouped_dependencies[key] << dependencies
         end
+        alert_incompatible_message(grouped_dependencies)
+      end
 
-        "Install #{missing.size} missing gem(s): #{color(:cyan) { command(gems) }}"
+      def no_gems_to_install
+        "No gems to install: #{Devpack::Messages.color(:green) { Devpack.config.requested_gems.size.to_s }} "\
+          "gems already installed from #{Devpack::Messages.color(:cyan) { Devpack.config.devpack_path }}"
       end
 
       def test
@@ -52,6 +76,15 @@ module Devpack
         "bundle exec gem install #{gems.join(' ')}"
       end
 
+      def alert_incompatible_message(grouped_dependencies)
+        incompatible_dependencies = grouped_dependencies.sort.map do |name, dependencies|
+          "#{color(:cyan) { name }}: "\
+            "#{dependencies.flatten.map { |dependency| color(:yellow) { dependency.to_s } }.join(', ')}"
+        end
+        "Unable to resolve version conflicts for #{color(:yellow) { incompatible_dependencies.size }} "\
+          "dependencies: #{incompatible_dependencies.join(', ')}}"
+      end
+
       def palette
         {
           reset: "\e[39m",

data/lib/devpack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Devpack
-  VERSION = '0.3.3'
+  VERSION = '0.4.1'
 end

data/lib/devpack.rb

@@ -15,12 +15,24 @@ require 'devpack/version'
 
 # Provides helper method for writing warning messages.
 module Devpack
-  class Error < StandardError; end
+  # Base class for all Devpack errors. Accepts additional argument `meta` to store object info.
+  class Error < StandardError
+    attr_reader :message, :meta
+
+    def initialize(message = nil, meta = nil)
+      @message = message
+      @meta = meta
+      super(message)
+    end
+  end
 
   class GemNotFoundError < Error; end
+  class GemIncompatibilityError < Error; end
 
   class << self
     def warn(level, message)
+      return if silent?
+
       prefixed = message.split("\n").map { |line| "#{prefix(level)} #{line}" }.join("\n")
       Kernel.warn(prefixed)
     end
@@ -33,6 +45,10 @@ module Devpack
       ENV.key?('DEVPACK_DISABLE')
     end
 
+    def silent?
+      ENV.key?('DEVPACK_SILENT')
+    end
+
     def rails?
       defined?(Rails::Railtie)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devpack
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
+date: 2023-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -98,7 +98,8 @@ description: Allow developers to optionally include a set of development gems wi
   adding to the Gemfile.
 email:
 - git@bob.frl
-executables: []
+executables:
+- devpack
 extensions: []
 extra_rdoc_files: []
 files:
@@ -115,12 +116,15 @@ files:
 - bin/console
 - bin/setup
 - devpack.gemspec
+- exe/devpack
 - lib/devpack.rb
 - lib/devpack/config.rb
+- lib/devpack/exec.rb
 - lib/devpack/gem_glob.rb
 - lib/devpack/gem_spec.rb
 - lib/devpack/gems.rb
 - lib/devpack/initializers.rb
+- lib/devpack/install.rb
 - lib/devpack/messages.rb
 - lib/devpack/railtie.rb
 - lib/devpack/timeable.rb
@@ -132,6 +136,7 @@ metadata:
   homepage_uri: https://github.com/bobf/devpack
   source_code_uri: https://github.com/bobf/devpack
   changelog_uri: https://github.com/bobf/devpack/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -147,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Conveniently tailor your development environment