devpack 0.2.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9502f5bb5412be236b272450cf30b9410a37676ce9a8ff7a769e01e08ebedc0f
-  data.tar.gz: f96bfcfbd97d530ee6a93ff54a8fef02066e5206c468d50d0ef0e4e8501055bc
+  metadata.gz: 3e708e92800fdb16f17e5f15decb2d89fd935ea0c2b473f243fa78b472f571f6
+  data.tar.gz: 24924053b2ee1c90ebc75e5eb0a8f7ee45d7196c63a059da761f68da5c0f1ee5
 SHA512:
-  metadata.gz: b94fee5740d2a0a57db65fdb9533d63397f0a1200babc95ea48104789084eab958570d0e659ba76cae1bbfc65e00839ab822ba9ebe300e8edc66d7490d28f266
-  data.tar.gz: 8d05d1b3839e26b658357613fa6f5a3f2c2251aa939aa6ac68b509cc9733530dddf21024933c11b84e52894bd48c7290fc713307b1e1882c04bd1d0b477d7eb6
+  metadata.gz: 935db175be08d441d07fb6ad177e2bfa80b971dad327f6f0d3f761f4507a00883bae57414c20bebf19451bef5318aecc3a1d93d0b0591c2fe06dd769b99f1514
+  data.tar.gz: '089ba6844efef952c3b2f72fbc27d6e87c770f29c6bc39f57e97f0a4000874ea380a829926297f846cdee386e4ab5e661a5dc98c4c02ca35408fbf4381d17948'

data/.rubocop.yml

@@ -3,52 +3,6 @@ Metrics/BlockLength:
     - "spec/**/*"
 
 AllCops:
+  NewCops: enable
   Exclude:
   - "spec/fixtures/**/*"
-
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/RedundantFetchBlock:
-  Enabled: true
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-Style/RedundantRegexpEscape:
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true
-Lint/DuplicateElsifCondition:
-  Enabled: true
-Style/AccessorGrouping:
-  Enabled: true
-Style/ArrayCoercion:
-  Enabled: true
-Style/BisectedAttrAccessor:
-  Enabled: true
-Style/CaseLikeIf:
-  Enabled: true
-Style/HashAsLastArrayItem:
-  Enabled: true
-Style/HashLikeCase:
-  Enabled: true
-Style/RedundantAssignment:
-  Enabled: true
-Style/RedundantFileExtensionInRequire:
-  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/README.md

@@ -4,44 +4,46 @@ Include a single gem in your `Gemfile` to allow developers to optionally include
 
 ## Installation
 
-Add the gem to your `Gemfile`:
+Create a file named `.devpack` in your project's directory, or in any parent directory:
+
+```
+# .devpack
+awesome_print
+byebug
+better_errors
+
+# Optionally specify a version:
+pry:0.13.1
+```
+
+Add _Devpack_ to any project's `Gemfile`:
 
 ```ruby
+# Gemfile
 group :development, :test do
-  gem 'devpack', '~> 0.2.1'
+  gem 'devpack', '~> 0.3.3'
 end
 ```
 
-And rebuild your bundle:
+Rebuild your bundle:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
 ## Usage
 
-Create a file named `.devpack` in your project's directory:
-
-```
-# .devpack
-awesome_print
-byebug
-better_errors
-
-# Optionally specify a version:
-pry:0.13.1
-```
+Load _Devpack_ (if your gems are not auto-loaded as in e.g. a _Rails_ application environment):
 
-All listed gems will be automatically required when _Devpack_ is loaded.
-
-If your gems are not auto-loaded (e.g. by _Rails_) then you must require the gem:
 ```ruby
 require 'devpack'
 ```
 
-Any gems that fail to load (due to `LoadError`) will generate a warning.
+_Devpack_ will attempt to load all configured gems immediately, providing feedback to _stderr_. All dependencies are loaded with `require` after being recursively verified for compatibily with bundled gems before loading.
+
+It is recommended to use a [global configuration](#global-configuration).
 
-It is recommended that `.devpack` is added to your `.gitignore`.
+When using a per-project configuration, `.devpack` files should be added to `.gitignore`.
 
 ### Initializers
 
@@ -68,7 +70,7 @@ Bullet.enable = true
 ```
 
 ### Global Configuration
-
+<a name="global-configuration"></a>
 To configure globally simply save your `.devpack` configuration file to any parent directory of your project directory, e.g. `~/.devpack`.
 
 This strategy also applies to `.devpack_initializers`.

data/devpack.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Allow developers to optionally include a set of development gems without adding to the Gemfile.'
   spec.homepage      = 'https://github.com/bobf/devpack'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'byebug', '~> 11.1'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
-  spec.add_development_dependency 'rubocop', '~> 0.88.0'
+  spec.add_development_dependency 'rubocop', '~> 1.8'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.1'
   spec.add_development_dependency 'strong_versions', '~> 0.4.4'
 end

data/lib/devpack/gem_glob.rb

@@ -4,7 +4,9 @@ module Devpack
   # Locates gems by searching in paths listed in GEM_PATH
   class GemGlob
     def find(name)
-      matched_paths(name).max { |a, b| version(a) <=> version(b) }
+      matched_paths(name)
+        .sort { |a, b| version(a) <=> version(b) }
+        .reverse
     end
 
     private
@@ -14,9 +16,9 @@ module Devpack
     end
 
     def gem_paths
-      return [] unless ENV.key?('GEM_PATH')
+      return [] if gem_path.nil?
 
-      ENV.fetch('GEM_PATH').split(':').map { |path| Pathname.new(path) }
+      gem_path.split(':').map { |path| Pathname.new(path) }
     end
 
     def match?(name_with_version, basename)
@@ -40,5 +42,12 @@ module Devpack
     def version(path)
       Gem::Version.new(File.split(path).last.rpartition('-').last)
     end
+
+    def gem_path
+      return ENV['GEM_PATH'] if ENV.key?('GEM_PATH')
+      return ENV['GEM_HOME'] if ENV.key?('GEM_HOME')
+
+      nil
+    end
   end
 end

data/lib/devpack/gem_spec.rb

@@ -4,30 +4,72 @@ module Devpack
   # Locates relevant gemspec for a given gem and provides a full list of paths
   # for all `require_paths` listed in gemspec.
   class GemSpec
-    def initialize(glob, name)
+    def initialize(glob, name, requirement)
       @name = name
       @glob = glob
+      @requirement = requirement
+      @dependency = Gem::Dependency.new(@name, @requirement)
     end
 
     def require_paths(visited = Set.new)
-      return [] unless gemspec_path&.exist? && gem_path&.exist?
+      raise GemNotFoundError, @requirement.nil? ? '-' : required_version if gemspec.nil?
 
-      (immediate_require_paths + dependency_require_paths(visited))
-        .compact.flatten.uniq
+      (immediate_require_paths + dependency_require_paths(visited)).compact.flatten.uniq
     end
 
     def gemspec
-      @gemspec ||= Gem::Specification.load(gemspec_path.to_s)
+      @gemspec ||= gemspecs.find do |spec|
+        next false if spec.nil?
+
+        @dependency.requirement.satisfied_by?(spec.version) && compatible?(spec)
+      end
     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)
+    end
+
+    def incompatible_version_loaded?(spec)
+      matched = Gem.loaded_specs[spec.name]
+      return false if matched.nil?
+
+      matched.version != spec.version
+    end
+
+    def required_version
+      @requirement.requirements.first.last.version
+    end
+
+    def compatible_specs?(specs, dependencies)
+      specs.all? { |spec| compatible_dependencies?(dependencies, spec) }
+    end
+
+    def compatible_dependencies?(dependencies, spec)
+      dependencies.all? { |dependency| compatible_dependency?(dependency, spec) }
+    end
+
+    def compatible_dependency?(dependency, spec)
+      return false if spec.nil?
+      return true unless dependency.name == spec.name
+
+      dependency.requirement.satisfied_by?(spec.version)
+    end
+
+    def gemspecs
+      @gemspecs ||= gemspec_paths.map { |path| Gem::Specification.load(path.to_s) }
+    end
+
     def dependency_require_paths(visited)
       dependencies.map do |dependency|
         next nil if visited.include?(dependency)
 
         visited << dependency
-        GemSpec.new(@glob, name_with_version(dependency)).require_paths(visited)
+        GemSpec.new(@glob, dependency.name, dependency.requirement).require_paths(visited)
       end
     end
 
@@ -35,34 +77,28 @@ module Devpack
       gemspec.runtime_dependencies
     end
 
-    def gem_path
-      return nil if located_gem.nil?
+    def gem_paths
+      return nil if candidates.empty?
 
-      Pathname.new(located_gem)
+      candidates.map { |candidate| Pathname.new(candidate) }
     end
 
-    def gemspec_path
-      return nil if gem_path.nil?
+    def gemspec_paths
+      return [] if gem_paths.nil?
 
-      gem_path.join('..', '..', 'specifications', "#{gem_path.basename}.gemspec")
-              .expand_path
+      gem_paths.map do |path|
+        path.join('..', '..', 'specifications', "#{path.basename}.gemspec").expand_path
+      end
     end
 
     def immediate_require_paths
       gemspec
         .require_paths
-        .map { |path| gem_path.join(path).to_s }
-    end
-
-    def name_with_version(dependency)
-      spec = dependency.to_spec
-      "#{spec.name}:#{spec.version}"
-    rescue Gem::MissingSpecError
-      dependency.name
+        .map { |path| File.join(gemspec.full_gem_path, path) }
     end
 
-    def located_gem
-      @located_gem ||= @glob.find(@name)
+    def candidates
+      @candidates ||= @glob.find(@name)
     end
   end
 end

data/lib/devpack/gems.rb

@@ -5,8 +5,11 @@ module Devpack
   class Gems
     include Timeable
 
-    def initialize(config)
+    def initialize(config, glob = GemGlob.new)
       @config = config
+      @gem_glob = glob
+      @failures = []
+      @missing = []
     end
 
     def load
@@ -14,35 +17,56 @@ module Devpack
 
       gems, time = timed { load_devpack }
       names = gems.map(&:first)
-      warn(Messages.loaded(@config.devpack_path, gems, time.round(2)))
+      summarize(gems, time)
       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)))
+      warn(:info, Messages.install_missing(@missing)) unless @missing.empty?
+    end
+
     def load_devpack
-      @config.requested_gems.map { |name| load_gem(name) }.compact
+      @config.requested_gems.map do |requested|
+        name, _, version = requested.partition(':')
+        load_gem(name, version.empty? ? nil : Gem::Requirement.new("= #{version}"))
+      end.compact
     end
 
-    def load_gem(name)
-      [name, activate(name)]
+    def load_gem(name, requirement)
+      [name, activate(name, requirement)]
     rescue LoadError => e
-      warn(Messages.failure(name, load_error_message(e)))
+      deactivate(name)
+      @failures << { name: name, message: load_error_message(e) }
+      nil
+    rescue GemNotFoundError => e
+      @missing << { name: name, version: e.message == '-' ? nil : e.message }
       nil
     end
 
-    def activate(name)
-      spec = GemSpec.new(gem_glob, name)
+    def activate(name, version)
+      spec = GemSpec.new(@gem_glob, name, version)
       update_load_path(spec.require_paths)
-      loaded = Kernel.require(name)
+      # NOTE: do this before we require, because some gems use the gemspec to
+      # declare their version...
       Gem.loaded_specs[name] = spec.gemspec
+      loaded = Kernel.require(name)
       spec.gemspec&.activated = true
       spec.gemspec&.instance_variable_set(:@loaded, true)
       loaded
     end
 
-    def warn(message)
-      Devpack.warn(message)
+    def deactivate(name)
+      Gem.loaded_specs.delete(name)
+    end
+
+    def warn(level, message)
+      Devpack.warn(level, message)
     end
 
     def load_error_message(error)
@@ -51,10 +75,6 @@ module Devpack
       %[(#{error.message})\n#{error.backtrace.join("\n")}]
     end
 
-    def gem_glob
-      @gem_glob ||= GemGlob.new
-    end
-
     def update_load_path(paths)
       $LOAD_PATH.concat(paths)
     end

data/lib/devpack/initializers.rb

@@ -15,7 +15,7 @@ module Devpack
       return if path.nil?
 
       args = path, initializers, time.round(2)
-      Devpack.warn(Messages.loaded_initializers(*args))
+      Devpack.warn(:success, Messages.loaded_initializers(*args))
     end
 
     private
@@ -27,7 +27,7 @@ module Devpack
     def load_initializer(path)
       require path
     rescue ScriptError, StandardError => e
-      Devpack.warn(Messages.initializer_failure(path, message(e)))
+      Devpack.warn(:error, Messages.initializer_failure(path, message(e)))
       nil
     end
 

data/lib/devpack/messages.rb

@@ -6,8 +6,7 @@ module Devpack
     class << self
       def failure(name, error_message)
         base = "Failed to load `#{name}`"
-        install = "bundle exec gem install #{name}"
-        "#{base}. Try `#{install}` #{error_message}"
+        "#{base}. #{error_message}"
       end
 
       def initializer_failure(path, error_message)
@@ -26,11 +25,44 @@ module Devpack
         "Loaded #{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]}"
+        end
+
+        "Install #{missing.size} missing gem(s): #{color(:cyan) { command(gems) }}"
+      end
+
+      def test
+        puts "#{color(:green) { 'green' }} #{color(:red) { 'red' }} #{color(:blue) { 'blue' }}"
+        puts "#{color(:cyan) { 'cyan' }} #{color(:yellow) { 'yellow' }} #{color(:magenta) { 'magenta' }}"
+      end
+
+      def color(name)
+        "#{palette.fetch(name)}#{yield}#{palette.fetch(:reset)}"
+      end
+
       private
 
       def indented(message)
         message.split("\n").map { |line| "  #{line}" }.join("\n")
       end
+
+      def command(gems)
+        "bundle exec gem install #{gems.join(' ')}"
+      end
+
+      def palette
+        {
+          reset: "\e[39m",
+          red: "\e[31m",
+          green: "\e[32m",
+          yellow: "\e[33m",
+          blue: "\e[34m",
+          magenta: "\e[35m",
+          cyan: "\e[36m"
+        }
+      end
     end
   end
 end

data/lib/devpack/version.rb

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

data/lib/devpack.rb

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'pathname'
+require 'set'
 
 require 'devpack/timeable'
 require 'devpack/config'
@@ -16,9 +17,11 @@ require 'devpack/version'
 module Devpack
   class Error < StandardError; end
 
+  class GemNotFoundError < Error; end
+
   class << self
-    def warn(message)
-      prefixed = message.split("\n").map { |line| "[devpack] #{line}" }.join("\n")
+    def warn(level, message)
+      prefixed = message.split("\n").map { |line| "#{prefix(level)} #{line}" }.join("\n")
       Kernel.warn(prefixed)
     end
 
@@ -37,6 +40,20 @@ module Devpack
     def config
       @config ||= Devpack::Config.new(Dir.pwd)
     end
+
+    private
+
+    def prefix(level)
+      "#{Messages.color(:blue) { '[' }}devpack#{Messages.color(:blue) { ']' }} #{icon(level)}"
+    end
+
+    def icon(level)
+      {
+        success: Messages.color(:green) { '✓' },
+        info: Messages.color(:cyan) { 'ℹ' },
+        error: Messages.color(:red) { '✗' }
+      }.fetch(level)
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devpack
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Bob Farrell
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -58,14 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: strong_versions
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -117,7 +132,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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,15 +140,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Conveniently tailor your development environment
 test_files: []