devpack 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0060c2ad41fd138a702fdd931eafdd5798940ea173e6a2aa30cb638a9975ee
-  data.tar.gz: 79d3b3d0c6de5c4dfc3795d6bdb6a58d5e0316e95dd85d609a1bcb6f3172f39e
+  metadata.gz: 9d17e8b2f27d6bf6dc15ff37e549e3f97a3550339daa6fba5db14174483c2197
+  data.tar.gz: e85c8dc654ae6fdf89c24ebaff90f0a14d2ae67b802b33a25430dde625c72a4b
 SHA512:
-  metadata.gz: c78cedc44a1fdab0fd5086776e9b6bb9a96c8ccffd34d83cf62e9b1b48da9fb3ae28161bacb048de8fbfc8c438c4c9bb4bcb63a5a56548e437facc6f3d7de042
-  data.tar.gz: e32424c2f6d7cc63fadbff9542c0980469837d0821378987e82830db4262e1c323b62e69c49188b9acf44a2823c78a262697ee383e2887ec748f78bbaee90f28
+  metadata.gz: 6095f9fe4d862df8a9a50ceccc1de6415f95a3e7a6749fd10076ff05e22244f343364e23231bb0270af7a1d0b9c02b5e627b82f49775c1cfa95cea10dc3f3c58
+  data.tar.gz: 79363c38a26853e07ef07ae3675ab867ce1d16bc52f1e31f6489ab1fd33e7cc09a45121a588c0b645a72a93c0adf1a0e5dfceb34424f0f1e5398d628e79f879e

data/.rubocop.yml

@@ -34,3 +34,21 @@ 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/CHANGELOG.md

@@ -15,3 +15,27 @@ Load latest version of gem by default. Allow specifying version with rubygems sy
 Permit comments in config file.
 
 Use `Gem::Specification` to load "rendered" gemspec (i.e. the file created by rubygems when the gem is installed).  This version of the gemspec will load very quickly so no need to do custom gemspec parsing any more. This also accounts for "missing" gemspecs.
+
+## 0.1.2
+
+Recursively include gem dependencies in `$LOAD_PATH` rather than assuming that any dependencies are already loaded.
+
+Include original error message when warning that a gem was unable to be loaded.
+
+## 0.1.3
+
+Use a more appropriate method of identifying the latest version of a gem (use `Gem::Version` to sort matched gem paths).
+
+Fix edge case where e.g. `pry-rails-0.1.0` was matching for `pry` due to naive match logic. Split on last dash instead of first (i.e. don't assume gems will not have a dash in their name; last dash separates gem name from version in directory name).
+
+## 0.2.0
+
+Add support for initializers. Files located in a `.devpack_initializers` directory will be loaded after gems configured in `.devpack` have been loaded. When using _Rails_ these files will be loaded using the `after_initialize` hook. Thanks to @joshmn for this idea: https://github.com/bobf/devpack/issues/1
+
+Show full tracebacks of load errors when `DEVPACK_DEBUG` is set in environment.
+
+Rename `DISABLE_DEVPACK` environment variable to `DEVPACK_DISABLE` for consistency.
+
+## 0.2.1
+
+Fully activate gem on load: add gem spec to `Gem.loaded_specs` and set instance variables `@loaded` and `@activated` to `true`. This mimics `Gem::Specification#activate` to ensure that anything that depends on these characteristics will function as normal.

data/Makefile

@@ -3,3 +3,7 @@ test:
 	bundle exec rspec
 	bundle exec rubocop
 	bundle exec strong_versions
+
+.PHONY: build
+build: test
+	bundle exec gem build devpack.gemspec

data/README.md

@@ -8,7 +8,7 @@ Add the gem to your `Gemfile`:
 
 ```ruby
 group :development, :test do
-  gem 'devpack', '~> 0.1.1'
+  gem 'devpack', '~> 0.3.0'
 end
 ```
 
@@ -32,19 +32,61 @@ better_errors
 pry:0.13.1
 ```
 
-All listed gems will be automatically required at launch. Any gems that fail to load will generate a warning.
+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.
+
+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 that `.devpack` is added to your `.gitignore`.
 
+### Initializers
+
+Custom initializers can be loaded by creating a directory named `.devpack_initializers` containing a set of `.rb` files.
+
+Initializers will be loaded in alphabetical order after all gems listed in the `.devpack` configuration file have been loaded.
+
+Initializers that fail to load (for any reason) will generate a warning.
+
+```ruby
+# .devpack_initializers/pry.rb
+
+Pry.config.pager = false
+```
+
+#### Rails
+
+If _Rails_ is detected then files in the `.devpack_initializers` directory will be loaded using the _Rails_ `after_initialize` hook (i.e. after all other frameworks have been initialized).
+
+```ruby
+# .devpack_initializers/bullet.rb
+
+Bullet.enable = true
+```
+
 ### Global Configuration
 
 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`.
+
 ### Disabling
 
-To disable _Devpack_ set the environment variable `DISABLE_DEVPACK` to any value:
+To disable _Devpack_ set the environment variable `DEVPACK_DISABLE` to any value:
+```bash
+DEVPACK_DISABLE=1 bundle exec ruby myapp.rb
+```
+
+### Debugging
+
+To see the full traceback of any errors encountered at load time set the environment variable `DEVPACK_DEBUG` to any value:
 ```bash
-DISABLE_DEVPACK=1 bundle exec ruby myapp.rb
+DEVPACK_DEBUG=1 bundle exec ruby myapp.rb
 ```
 
 ## License

data/devpack.gemspec

@@ -28,6 +28,6 @@ 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.86.0'
+  spec.add_development_dependency 'rubocop', '~> 0.88.0'
   spec.add_development_dependency 'strong_versions', '~> 0.4.4'
 end

data/lib/devpack.rb

@@ -2,19 +2,48 @@
 
 require 'rubygems'
 require 'pathname'
+require 'set'
 
+require 'devpack/timeable'
 require 'devpack/config'
 require 'devpack/gems'
 require 'devpack/gem_glob'
-require 'devpack/gem_path'
+require 'devpack/gem_spec'
+require 'devpack/initializers'
 require 'devpack/messages'
 require 'devpack/version'
 
+# Provides helper method for writing warning messages.
 module Devpack
   class Error < StandardError; end
+
+  class << self
+    def warn(message)
+      prefixed = message.split("\n").map { |line| "[devpack] #{line}" }.join("\n")
+      Kernel.warn(prefixed)
+    end
+
+    def debug?
+      ENV.key?('DEVPACK_DEBUG')
+    end
+
+    def disabled?
+      ENV.key?('DEVPACK_DISABLE')
+    end
+
+    def rails?
+      defined?(Rails::Railtie)
+    end
+
+    def config
+      @config ||= Devpack::Config.new(Dir.pwd)
+    end
+  end
 end
 
-unless ENV.key?('DISABLE_DEVPACK')
-  config = Devpack::Config.new(Dir.pwd)
-  Devpack::Gems.new(config).load
+unless Devpack.disabled?
+  require 'devpack/railtie' if Devpack.rails?
+
+  Devpack::Gems.new(Devpack.config).load
+  Devpack::Initializers.new(Devpack.config).load unless Devpack.rails?
 end

data/lib/devpack/config.rb

@@ -4,6 +4,7 @@ module Devpack
   # Locates and parses .devpack config file
   class Config
     FILENAME = '.devpack'
+    INITIALIZERS_DIRECTORY_NAME = '.devpack_initializers'
     MAX_PARENTS = 100 # Avoid infinite loops (symlinks/weird file systems)
 
     def initialize(pwd)
@@ -19,18 +20,26 @@ module Devpack
     end
 
     def devpack_path
-      @devpack_path ||= located_config_path(@pwd)
+      @devpack_path ||= located_path(@pwd, FILENAME, :file)
+    end
+
+    def devpack_initializers_path
+      @devpack_initializers_path ||= located_path(@pwd, INITIALIZERS_DIRECTORY_NAME, :directory)
+    end
+
+    def devpack_initializer_paths
+      devpack_initializers_path&.glob(File.join('**', '*.rb'))&.map(&:to_s)&.sort || []
     end
 
     private
 
-    def located_config_path(next_parent)
+    def located_path(next_parent, filename, type)
       loop.with_index(1) do |_, index|
         return nil if index > MAX_PARENTS
 
-        path = next_parent.join(FILENAME)
+        path = next_parent.join(filename)
         next_parent = next_parent.parent
-        next unless File.exist?(path)
+        next unless File.exist?(path) && File.public_send("#{type}?", path)
 
         return path
       end

data/lib/devpack/gem_glob.rb

@@ -4,13 +4,9 @@ module Devpack
   # Locates gems by searching in paths listed in GEM_PATH
   class GemGlob
     def find(name)
-      glob.select do |path|
-        pathname = Pathname.new(path)
-        next unless pathname.directory?
-
-        basename = pathname.basename.to_s
-        match?(name, basename)
-      end.max # FIXME: Quick-and-dirty way to get latest version - will have many edge cases.
+      matched_paths(name)
+        .sort { |a, b| version(a) <=> version(b) }
+        .reverse
     end
 
     private
@@ -27,10 +23,24 @@ module Devpack
 
     def match?(name_with_version, basename)
       name, _, version = name_with_version.partition(':')
-      return true if version.empty? && basename.start_with?("#{name}-")
+      return true if version.empty? && basename.rpartition('-').first == name
       return true if !version.empty? && basename == "#{name}-#{version}"
 
       false
     end
+
+    def matched_paths(name)
+      glob.select do |path|
+        pathname = Pathname.new(path)
+        next unless pathname.directory?
+
+        basename = pathname.basename.to_s
+        match?(name, basename)
+      end
+    end
+
+    def version(path)
+      Gem::Version.new(File.split(path).last.rpartition('-').last)
+    end
   end
 end

data/lib/devpack/gem_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+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, requirement)
+      @name = name
+      @glob = glob
+      @requirement = requirement
+      @dependency = Gem::Dependency.new(@name, @requirement)
+    end
+
+    def require_paths(visited = Set.new)
+      raise LoadError, Messages.no_compatible_version(@dependency) if gemspec.nil?
+
+      (immediate_require_paths + dependency_require_paths(visited)).compact.flatten.uniq
+    end
+
+    def gemspec
+      @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 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, dependency.name, dependency.requirement).require_paths(visited)
+      end
+    end
+
+    def dependencies
+      gemspec.runtime_dependencies
+    end
+
+    def gem_paths
+      return nil if candidates.empty?
+
+      candidates.map { |candidate| Pathname.new(candidate) }
+    end
+
+    def gemspec_paths
+      return [] if gem_paths.nil?
+
+      gem_paths.map do |path|
+        path.join('..', '..', 'specifications', "#{path.basename}.gemspec").expand_path
+      end
+    end
+
+    def immediate_require_paths
+      gemspec
+        .require_paths
+        .map { |path| File.join(gemspec.full_gem_path, path) }
+    end
+
+    def candidates
+      @candidates ||= @glob.find(@name)
+    end
+  end
+end

data/lib/devpack/gems.rb

@@ -3,8 +3,11 @@
 module Devpack
   # Loads requested gems from configuration
   class Gems
-    def initialize(config)
+    include Timeable
+
+    def initialize(config, glob = GemGlob.new)
       @config = config
+      @gem_glob = glob
     end
 
     def load
@@ -12,40 +15,48 @@ module Devpack
 
       gems, time = timed { load_devpack }
       names = gems.map(&:first)
-      warn(Messages.loaded_message(@config.devpack_path, gems, time.round(2)))
+      warn(Messages.loaded(@config.devpack_path, gems, time.round(2)))
       names
     end
 
     private
 
-    def timed
-      start = Time.now.utc
-      result = yield
-      [result, Time.now.utc - start]
-    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)
-      update_load_path(name)
-      [name, Kernel.require(name)]
-    rescue LoadError
-      warn(Messages.failure_message(name))
+    def load_gem(name, requirement)
+      [name, activate(name, requirement)]
+    rescue LoadError => e
+      warn(Messages.failure(name, load_error_message(e)))
       nil
     end
 
+    def activate(name, version)
+      spec = GemSpec.new(@gem_glob, name, version)
+      update_load_path(spec.require_paths)
+      loaded = Kernel.require(name)
+      Gem.loaded_specs[name] = spec.gemspec
+      spec.gemspec&.activated = true
+      spec.gemspec&.instance_variable_set(:@loaded, true)
+      loaded
+    end
+
     def warn(message)
-      Kernel.warn("[devpack] #{message}")
+      Devpack.warn(message)
     end
 
-    def gem_glob
-      @gem_glob ||= GemGlob.new
+    def load_error_message(error)
+      return "(#{error.message})" unless Devpack.debug?
+
+      %[(#{error.message})\n#{error.backtrace.join("\n")}]
     end
 
-    def update_load_path(name)
-      $LOAD_PATH.concat(GemPath.new(gem_glob, name).require_paths)
+    def update_load_path(paths)
+      $LOAD_PATH.concat(paths)
     end
   end
 end

data/lib/devpack/initializers.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Devpack
+  # Loads requested initializers from configuration
+  class Initializers
+    include Timeable
+
+    def initialize(config)
+      @config = config
+    end
+
+    def load
+      initializers, time = timed { load_initializers }
+      path = @config.devpack_initializers_path
+      return if path.nil?
+
+      args = path, initializers, time.round(2)
+      Devpack.warn(Messages.loaded_initializers(*args))
+    end
+
+    private
+
+    def load_initializers
+      @config.devpack_initializer_paths.map { |path| load_initializer(path) }
+    end
+
+    def load_initializer(path)
+      require path
+    rescue ScriptError, StandardError => e
+      Devpack.warn(Messages.initializer_failure(path, message(e)))
+      nil
+    end
+
+    def message(error)
+      return "(#{error.class.name} - #{error.message&.split("\n")&.first})" unless Devpack.debug?
+
+      %[(#{error.class.name})\n#{error.message}\n#{error.backtrace.join("\n")}]
+    end
+  end
+end

data/lib/devpack/messages.rb

@@ -3,18 +3,37 @@
 module Devpack
   # Generates output messages.
   class Messages
-    def self.failure_message(name)
-      base = "Failed to load `#{name}`"
-      install = "bundle exec gem install #{name}"
-      "#{base}. Try `#{install}`"
-    end
+    class << self
+      def failure(name, error_message)
+        base = "Failed to load `#{name}`"
+        "#{base}. #{error_message}"
+      end
+
+      def initializer_failure(path, error_message)
+        "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
+
+        "#{base} (#{gems.size - already_loaded} gem(s) were already loaded by environment)."
+      end
+
+      def loaded_initializers(path, initializers, time)
+        "Loaded #{initializers.compact.size} initializer(s) from '#{path}' in #{time} seconds"
+      end
+
+      def no_compatible_version(dependency)
+        "No compatible version found for `#{dependency.requirement}`"
+      end
 
-    def self.loaded_message(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
+      private
 
-      "#{base} (#{gems.size - already_loaded} gem(s) were already loaded by environment)."
+      def indented(message)
+        message.split("\n").map { |line| "  #{line}" }.join("\n")
+      end
     end
   end
 end

data/lib/devpack/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Devpack
+  # Loads Devpack initializers after standard Rails initializers have been loaded.
+  class Railtie < Rails::Railtie
+    config.after_initialize { Devpack::Initializers.new(Devpack.config).load }
+  end
+end

data/lib/devpack/timeable.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Provides result and run time of a given block.
+module Timeable
+  def timed
+    start = Time.now.utc
+    result = yield
+    [result, Time.now.utc - start]
+  end
+end

data/lib/devpack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devpack
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Bob Farrell
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-05 00:00:00.000000000 Z
+date: 2020-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.88.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.88.0
 - !ruby/object:Gem::Dependency
   name: strong_versions
   requirement: !ruby/object:Gem::Requirement
@@ -103,9 +103,12 @@ files:
 - lib/devpack.rb
 - lib/devpack/config.rb
 - lib/devpack/gem_glob.rb
-- lib/devpack/gem_path.rb
+- lib/devpack/gem_spec.rb
 - lib/devpack/gems.rb
+- lib/devpack/initializers.rb
 - lib/devpack/messages.rb
+- lib/devpack/railtie.rb
+- lib/devpack/timeable.rb
 - lib/devpack/version.rb
 homepage: https://github.com/bobf/devpack
 licenses:
@@ -114,7 +117,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
@@ -130,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Conveniently tailor your development environment
 test_files: []

data/lib/devpack/gem_path.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Devpack
-  # Locates relevant gemspec for a given gem and provides a full list of paths
-  # for all `require_paths` listed in gemspec.
-  class GemPath
-    def initialize(glob, name)
-      @name = name
-      @glob = glob
-    end
-
-    def require_paths
-      return [] unless gemspec_path&.exist? && gem_path&.exist?
-
-      Gem::Specification
-        .load(gemspec_path.to_s)
-        .require_paths
-        .map { |path| gem_path.join(path).to_s }
-    end
-
-    private
-
-    def gem_path
-      return nil if located_gem.nil?
-
-      Pathname.new(located_gem)
-    end
-
-    def gemspec_path
-      return nil if gem_path.nil?
-
-      gem_path.join('..', '..', 'specifications', "#{gem_path.basename}.gemspec")
-              .expand_path
-    end
-
-    def located_gem
-      @located_gem ||= @glob.find(@name)
-    end
-  end
-end