devpack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0853562f5cbb43d560d36d6913f3e1a7bc44ffb49561183146b65a6c69c2f6bb'
+  data.tar.gz: 63cb7a8c6d3bed3bb8806c7a2b3dcd12a82728cfe177c7e7c8f4f6f64112b071
+SHA512:
+  metadata.gz: b814b628151622a7780f74356d77e94528a1053eb14cac5334faa5fb2784ec0114773d0c641cde3091ba0b12dde8010ed74efbed2f457cea5581abb9fc95fbb1
+  data.tar.gz: 0cea088ec5ba97520eab7734813d972b03cab7332447e3ff3b375716c54bfa87ddcee5168e06fc99c5f469fc4d79a15b599b26d8488e0c8c926ad1871322d62c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,32 @@
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+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

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bob Farrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,5 @@
+.PHONY: test
+test:
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions

data/README.md

@@ -0,0 +1,48 @@
+# Devpack
+
+Conveniently load a set of gems to tailor your development environment without modifying your application's _Gemfile_. Configurable globally or per-project.
+
+## Installation
+
+Add the gem to your `Gemfile`:
+
+```ruby
+group :development, :test do
+  gem 'devpack', '~> 0.1.0'
+end
+```
+
+And rebuild your bundle:
+
+```bash
+$ 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:
+
+```
+# .devpack
+awesome_print
+byebug
+better_errors
+```
+
+All listed gems will be automatically required.
+
+It is recommended that the `.devpack` file is added to your `.gitignore`:
+
+```
+# .gitignore
+.devpack
+```
+
+To disable _Devpack_ set the environment variable `DISABLE_DEVPACK` to any value:
+```bash
+DISABLE_DEVPACK=1 bundle exec ruby myapp.rb
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'devpack'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/devpack.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/devpack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'devpack'
+  spec.version       = Devpack::VERSION
+  spec.authors       = ['Bob Farrell']
+  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.homepage      = 'https://github.com/bobf/devpack'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  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.require_paths = ['lib']
+
+  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 'strong_versions', '~> 0.4.4'
+end

data/lib/devpack.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'pathname'
+
+require 'devpack/version'
+require 'devpack/gems'
+require 'devpack/gem_specification_context'
+
+module Devpack
+  class Error < StandardError; end
+end
+
+Devpack::Gems.new('.').load unless ENV.key?('DISABLE_DEVPACK')

data/lib/devpack/gem_specification_context.rb

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

data/lib/devpack/gems.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Devpack
+  # Parses .devpack file and provides/loads a list of specified gems
+  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)
+    end
+
+    def load
+      path = devpack_path
+      return [] if path.nil?
+
+      gems, time = timed { load_devpack(path) }
+      names = gems.map(&:first)
+      warn(loaded_message(path, gems, time))
+      names
+    end
+
+    private
+
+    def timed
+      start = Time.now.utc
+      result = yield
+      [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)
+    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)
+      [name, Kernel.require(name)]
+    rescue LoadError
+      warn(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)
+    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)."
+    end
+  end
+end

data/lib/devpack/version.rb

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

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: devpack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Farrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+- !ruby/object:Gem::Dependency
+  name: strong_versions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+description: Provide a list of gems to load in your own environment
+email:
+- git@bob.frl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- devpack.gemspec
+- lib/devpack.rb
+- lib/devpack/gem_specification_context.rb
+- lib/devpack/gems.rb
+- lib/devpack/version.rb
+homepage: https://github.com/bobf/devpack
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Conveniently tailor your development environment
+test_files: []