devpack 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0853562f5cbb43d560d36d6913f3e1a7bc44ffb49561183146b65a6c69c2f6bb'
-  data.tar.gz: 63cb7a8c6d3bed3bb8806c7a2b3dcd12a82728cfe177c7e7c8f4f6f64112b071
+  metadata.gz: 4e0060c2ad41fd138a702fdd931eafdd5798940ea173e6a2aa30cb638a9975ee
+  data.tar.gz: 79d3b3d0c6de5c4dfc3795d6bdb6a58d5e0316e95dd85d609a1bcb6f3172f39e
 SHA512:
-  metadata.gz: b814b628151622a7780f74356d77e94528a1053eb14cac5334faa5fb2784ec0114773d0c641cde3091ba0b12dde8010ed74efbed2f457cea5581abb9fc95fbb1
-  data.tar.gz: 0cea088ec5ba97520eab7734813d972b03cab7332447e3ff3b375716c54bfa87ddcee5168e06fc99c5f469fc4d79a15b599b26d8488e0c8c926ad1871322d62c
+  metadata.gz: c78cedc44a1fdab0fd5086776e9b6bb9a96c8ccffd34d83cf62e9b1b48da9fb3ae28161bacb048de8fbfc8c438c4c9bb4bcb63a5a56548e437facc6f3d7de042
+  data.tar.gz: e32424c2f6d7cc63fadbff9542c0980469837d0821378987e82830db4262e1c323b62e69c49188b9acf44a2823c78a262697ee383e2887ec748f78bbaee90f28

data/.gitignore

@@ -10,3 +10,5 @@
 # rspec failure tracking
 .rspec_status
 Gemfile.lock
+
+devpack-*.gem

data/.rubocop.yml

@@ -2,6 +2,10 @@ Metrics/BlockLength:
   Exclude:
     - "spec/**/*"
 
+AllCops:
+  Exclude:
+  - "spec/fixtures/**/*"
+
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
 Layout/SpaceAroundMethodCallOperator:

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 0.1.0
+
+Core functionality implemented. Load a `.devpack` configuration file from current directory or, if not present, from a parent directory. Attempt to locate and `require` all listed gems.
+
+## 0.1.1
+
+Use `GEM_PATH` instead of `GEM_HOME` to locate gems.
+
+Optimise load time by searching non-recursively in `/gems` directory (for each path listed in `GEM_PATH`).
+
+Load latest version of gem by default. Allow specifying version with rubygems syntax `example:0.1.0`.
+
+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.

data/README.md

@@ -1,6 +1,6 @@
 # Devpack
 
-Conveniently load a set of gems to tailor your development environment without modifying your application's _Gemfile_. Configurable globally or per-project.
+Include a single gem in your `Gemfile` to allow developers to optionally include their preferred set of development gems without cluttering the `Gemfile`. Configurable globally or per-project.
 
 ## Installation
 
@@ -8,7 +8,7 @@ Add the gem to your `Gemfile`:
 
 ```ruby
 group :development, :test do
-  gem 'devpack', '~> 0.1.0'
+  gem 'devpack', '~> 0.1.1'
 end
 ```
 
@@ -20,23 +20,27 @@ $ bundle install
 
 ## Usage
 
-Create a file named `.devpack` in your project's directory (or any parent directory) containing a list of gems you wish to load:
+Create a file named `.devpack` in your project's directory:
 
 ```
 # .devpack
 awesome_print
 byebug
 better_errors
+
+# Optionally specify a version:
+pry:0.13.1
 ```
 
-All listed gems will be automatically required.
+All listed gems will be automatically required at launch. Any gems that fail to load will generate a warning.
 
-It is recommended that the `.devpack` file is added to your `.gitignore`:
+It is recommended that `.devpack` is added to your `.gitignore`.
 
-```
-# .gitignore
-.devpack
-```
+### Global Configuration
+
+To configure globally simply save your `.devpack` configuration file to any parent directory of your project directory, e.g. `~/.devpack`.
+
+### Disabling
 
 To disable _Devpack_ set the environment variable `DISABLE_DEVPACK` to any value:
 ```bash

data/devpack.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['git@bob.frl']
 
   spec.summary       = 'Conveniently tailor your development environment'
-  spec.description   = 'Provide a list of gems to load in your own environment'
+  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')

data/lib/devpack.rb

@@ -3,12 +3,18 @@
 require 'rubygems'
 require 'pathname'
 
-require 'devpack/version'
+require 'devpack/config'
 require 'devpack/gems'
-require 'devpack/gem_specification_context'
+require 'devpack/gem_glob'
+require 'devpack/gem_path'
+require 'devpack/messages'
+require 'devpack/version'
 
 module Devpack
   class Error < StandardError; end
 end
 
-Devpack::Gems.new('.').load unless ENV.key?('DISABLE_DEVPACK')
+unless ENV.key?('DISABLE_DEVPACK')
+  config = Devpack::Config.new(Dir.pwd)
+  Devpack::Gems.new(config).load
+end

data/lib/devpack/config.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Devpack
+  # Locates and parses .devpack config file
+  class Config
+    FILENAME = '.devpack'
+    MAX_PARENTS = 100 # Avoid infinite loops (symlinks/weird file systems)
+
+    def initialize(pwd)
+      @pwd = Pathname.new(pwd)
+    end
+
+    def requested_gems
+      return nil if devpack_path.nil?
+
+      File.readlines(devpack_path)
+          .map(&filter_comments)
+          .compact
+    end
+
+    def devpack_path
+      @devpack_path ||= located_config_path(@pwd)
+    end
+
+    private
+
+    def located_config_path(next_parent)
+      loop.with_index(1) do |_, index|
+        return nil if index > MAX_PARENTS
+
+        path = next_parent.join(FILENAME)
+        next_parent = next_parent.parent
+        next unless File.exist?(path)
+
+        return path
+      end
+    end
+
+    def filter_comments
+      proc do |line|
+        stripped = line.strip
+        next nil if stripped.empty?
+        next nil if stripped.start_with?('#')
+
+        stripped.gsub(/\s*#.*$/, '') # Remove inline comments (like this one)
+      end
+    end
+  end
+end

data/lib/devpack/gem_glob.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+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.
+    end
+
+    private
+
+    def glob
+      @glob ||= gem_paths.map { |path| Dir.glob(path.join('gems', '*')) }.flatten
+    end
+
+    def gem_paths
+      return [] unless ENV.key?('GEM_PATH')
+
+      ENV.fetch('GEM_PATH').split(':').map { |path| Pathname.new(path) }
+    end
+
+    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 == "#{name}-#{version}"
+
+      false
+    end
+  end
+end

data/lib/devpack/gem_path.rb

@@ -0,0 +1,40 @@
+# 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

data/lib/devpack/gems.rb

@@ -1,24 +1,18 @@
 # frozen_string_literal: true
 
 module Devpack
-  # Parses .devpack file and provides/loads a list of specified gems
+  # Loads requested gems from configuration
   class Gems
-    FILENAME = '.devpack'
-    MAX_PARENTS = 100 # Avoid infinite loops (symlinks/weird file systems)
-
-    def initialize(path)
-      @load_path = $LOAD_PATH
-      @gem_home = Pathname.new(ENV['GEM_HOME'])
-      @path = Pathname.new(path)
+    def initialize(config)
+      @config = config
     end
 
     def load
-      path = devpack_path
-      return [] if path.nil?
+      return [] if @config.requested_gems.nil?
 
-      gems, time = timed { load_devpack(path) }
+      gems, time = timed { load_devpack }
       names = gems.map(&:first)
-      warn(loaded_message(path, gems, time))
+      warn(Messages.loaded_message(@config.devpack_path, gems, time.round(2)))
       names
     end
 
@@ -30,106 +24,28 @@ module Devpack
       [result, Time.now.utc - start]
     end
 
-    def load_devpack(path)
-      gem_list(path).map { |name| load_gem(name) }.compact
-    end
-
-    def devpack_path
-      return default_devpack_path if File.exist?(default_devpack_path)
-      return parent_devpack_path unless parent_devpack_path.nil?
-
-      nil
-    end
-
-    def default_devpack_path
-      @path.join(FILENAME)
-    end
-
-    def gem_list(path)
-      File.readlines(path).map(&:chomp)
+    def load_devpack
+      @config.requested_gems.map { |name| load_gem(name) }.compact
     end
 
     def load_gem(name)
-      # TODO: Decide what to do when Bundler is not defined.
-      # Do we want to support this scenario ?
-      update_load_path(name) if defined?(Bundler)
+      update_load_path(name)
       [name, Kernel.require(name)]
     rescue LoadError
-      warn(failure_message(name))
+      warn(Messages.failure_message(name))
       nil
     end
 
-    def parent_devpack_path
-      next_parent = @path.parent
-      loop.with_index(1) do |_, index|
-        break if index >= MAX_PARENTS
-
-        next_parent = next_parent.parent
-        break if next_parent == next_parent.parent
-
-        path = next_parent.join(FILENAME)
-        next unless File.exist?(path)
-
-        return path
-      end
-    end
-
     def warn(message)
       Kernel.warn("[devpack] #{message}")
     end
 
-    def gems_glob
-      @gems_glob ||= Dir.glob(@gem_home.join('gems', '**', '*'))
-    end
-
-    def gem_path(name)
-      found = gems_glob.find do |path|
-        pathname = Pathname.new(path)
-        next unless pathname.directory?
-
-        # TODO: We should allow optionally specifying a version and default to loading
-        # the latest version available.
-        pathname.basename.to_s.start_with?("#{name}-")
-      end
-
-      found.nil? ? nil : Pathname.new(found)
+    def gem_glob
+      @gem_glob ||= GemGlob.new
     end
 
     def update_load_path(name)
-      path = gem_path(name)
-      return if path.nil?
-
-      $LOAD_PATH.concat(require_paths(path, name))
-    end
-
-    def require_paths(gem_path, name)
-      gemspec_path = gem_path.join("#{name}.gemspec")
-      lib_path = gem_path.join('lib')
-      # REVIEW: Some gems don't have a .gemspec - need to understand how they are loaded.
-      # Use `/lib` for now if it exists as this will work for vast majority of cases.
-      return [lib_path] if !gemspec_path.exist? && lib_path.exist?
-
-      gemspec = File.read(gemspec_path.to_s)
-      GemSpecificationContext.class_eval(gemspec)
-      full_require_paths(gem_path)
-    end
-
-    def full_require_paths(base_path)
-      GemSpecificationContext.require_paths.map { |path| base_path.join(path) }
-    end
-
-    def failure_message(name)
-      base = "Failed to load `#{name}`"
-      install = (defined?(Bundler) ? 'bundle exec ' : '') + "gem install #{name}"
-      "#{base}. Try `#{install}`"
-    end
-
-    def 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
-
-      "#{base} (#{gems.size - already_loaded} gem(s) were already loaded by environment)."
+      $LOAD_PATH.concat(GemPath.new(gem_glob, name).require_paths)
     end
   end
 end

data/lib/devpack/messages.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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
+
+    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
+
+      "#{base} (#{gems.size - already_loaded} gem(s) were already loaded by environment)."
+    end
+  end
+end

data/lib/devpack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devpack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-04 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -80,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.4
-description: Provide a list of gems to load in your own environment
+description: Allow developers to optionally include a set of development gems without
+  adding to the Gemfile.
 email:
 - git@bob.frl
 executables: []
@@ -90,6 +91,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - Makefile
@@ -99,8 +101,11 @@ files:
 - bin/setup
 - devpack.gemspec
 - lib/devpack.rb
-- lib/devpack/gem_specification_context.rb
+- lib/devpack/config.rb
+- lib/devpack/gem_glob.rb
+- lib/devpack/gem_path.rb
 - lib/devpack/gems.rb
+- lib/devpack/messages.rb
 - lib/devpack/version.rb
 homepage: https://github.com/bobf/devpack
 licenses:

data/lib/devpack/gem_specification_context.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module Devpack
-  # Stubbed instance_eval context to evaluate a .gemspec file and extract required_paths
-  # Avoids doing expensive operations (e.g. attempting to run `git ls-files`) which are
-  # typically invoked when using `Gem::Specification.load`.
-  class GemSpecificationContext
-    def initialize(*_); end
-
-    class << self
-      attr_accessor :require_paths
-
-      @require_paths = []
-
-      def require(*_); end
-
-      def __dir__
-        '.'
-      end
-
-      def require_relative(*_); end
-    end
-
-    module Gem
-      # Stubbed Rubygems Gem::Specification. Everything except `require_paths=` is a no-op.
-      # Catches errors for missing constants and attempts to set them in the class_eval context.
-      # Constants are set recursively by setting each constant to GemSpecificationContext.
-      class Specification
-        def initialize(*_)
-          GemSpecificationContext.require_paths = []
-          begin
-            yield self
-          rescue NameError => e
-            __devpack_resolved_receiver(e).const_set(e.name, GemSpecificationContext)
-            retry
-          end
-        end
-
-        def require_paths=(paths)
-          GemSpecificationContext.require_paths.concat(paths)
-        end
-
-        private
-
-        def __devpack_resolved_receiver(error)
-          error.receiver
-        rescue ArgumentError
-          GemSpecificationContext
-        end
-
-        # rubocop:disable Style/MethodMissingSuper
-        def method_missing(method_name, *args)
-          return self unless Kernel.respond_to?(method_name)
-
-          Kernel.public_send(method_name, *args)
-        end
-        # rubocop:enable Style/MethodMissingSuper
-
-        def respond_to_missing?(*_)
-          true
-        end
-      end
-    end
-  end
-end