devpack 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d0f6b9fad66aac0d4cbf7d9b2b0ce83de1b9ef159ce568ba74585e387d7ca49
-  data.tar.gz: c9e8dccdebba5fa96bd4e3437f526196ca0ca06f92e29f64c957aef252d24c98
+  metadata.gz: 335c743ca50fef7d6141bc5a0c8f1a4525fe4a5aeca591be30fbe2501f160b94
+  data.tar.gz: ead8cd42535bd8a0e5cc869786b9cc49e257706b0e47ed583714e01765a1cb32
 SHA512:
-  metadata.gz: dc5fbfee439392e48cbad78dcc427969e3177e74c2d633869e73392c3f32c9e3890eed458e10e1dc40f49c01239711ee172c84941165ee778d59b726d394e05b
-  data.tar.gz: 8255b841d85e24b4b6a0cbf90c5f0d47612654360f3f64ea01e82b37c9dcaed74d0e4c09e0fd502edc95a514b362ba5c7c9c7c284bdd87fd499ff0c930e3d7bb
+  metadata.gz: 7c7652e4385dd4cf5a5ae4faaf791ecbe9a53900eccc88ae62fa50c2a98e922eab7191c459992d488d511b65a441874f2920fd142fe19f265e5b0a70306732c0
+  data.tar.gz: 0a129da29674bc71c1ea270c6f9aa5cef1eb31fe98828b2d0b8b9ee98e36277e3a8cb07e7e3156a756e34ddc1bbd6ae055c0c849001dbf6fb40dd9d98c870fa6

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,46 +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.3.1'
+  gem 'devpack', '~> 0.3.2'
 end
 ```
 
-And rebuild your bundle:
+Rebuild your bundle:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
 ## Usage
 
-Create a file named `.devpack` in your project's directory:
+Load _Devpack_ (if your gems are not auto-loaded as in e.g. a _Rails_ application environment):
 
-```
-# .devpack
-awesome_print
-byebug
-better_errors
-
-# Optionally specify a version:
-pry:0.13.1
-```
-
-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.
 
-All dependencies are recursively verified for compatibily before loading. If no compatible version can be located then the gem will not be loaded.
+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
 
@@ -70,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.rb

@@ -17,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
 
@@ -38,6 +40,14 @@ module Devpack
     def config
       @config ||= Devpack::Config.new(Dir.pwd)
     end
+
+    private
+
+    def prefix(level)
+      color = { success: '32', info: '36', error: '31' }.fetch(level)
+      icon = { success: '✓', info: 'ℹ', error: '✗' }.fetch(level)
+      "\e[34m[\e[39mdevpack\e[34m]\e[39m \e[#{color}m#{icon}\e[39m"
+    end
   end
 end
 

data/lib/devpack/gem_spec.rb

@@ -12,7 +12,7 @@ module Devpack
     end
 
     def require_paths(visited = Set.new)
-      raise LoadError, Messages.no_compatible_version(@dependency) if gemspec.nil?
+      raise GemNotFoundError, @requirement.nil? ? '-' : required_version if gemspec.nil?
 
       (immediate_require_paths + dependency_require_paths(visited)).compact.flatten.uniq
     end
@@ -41,6 +41,10 @@ module Devpack
       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

data/lib/devpack/gems.rb

@@ -8,6 +8,8 @@ module Devpack
     def initialize(config, glob = GemGlob.new)
       @config = config
       @gem_glob = glob
+      @failures = []
+      @missing = []
     end
 
     def load
@@ -15,12 +17,20 @@ 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 do |requested|
         name, _, version = requested.partition(':')
@@ -32,7 +42,10 @@ module Devpack
       [name, activate(name, requirement)]
     rescue LoadError => e
       deactivate(name)
-      warn(Messages.failure(name, load_error_message(e)))
+      @failures << { name: name, message: load_error_message(e) }
+      nil
+    rescue GemNotFoundError => e
+      @missing << { name: name, version: e.message == '-' ? nil : e.message }
       nil
     end
 
@@ -52,8 +65,8 @@ module Devpack
       Gem.loaded_specs.delete(name)
     end
 
-    def warn(message)
-      Devpack.warn(message)
+    def warn(level, message)
+      Devpack.warn(level, message)
     end
 
     def load_error_message(error)

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

@@ -25,8 +25,12 @@ module Devpack
         "Loaded #{initializers.compact.size} initializer(s) from '#{path}' in #{time} seconds"
       end
 
-      def no_compatible_version(dependency)
-        "No compatible version found for `#{dependency.requirement}`"
+      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): #{command(gems)}"
       end
 
       private
@@ -34,6 +38,10 @@ module Devpack
       def indented(message)
         message.split("\n").map { |line| "  #{line}" }.join("\n")
       end
+
+      def command(gems)
+        "bundle exec gem install #{gems.join(' ')}"
+      end
     end
   end
 end

data/lib/devpack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devpack
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-01-09 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
@@ -125,14 +140,15 @@ 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
+rubyforge_project:
+rubygems_version: 2.7.6.2
 signing_key:
 specification_version: 4
 summary: Conveniently tailor your development environment