devpack 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57a7f13b41361d7f9c45a147a99221d6f88e3b8d0ee1ede4f59ccdaeb878c7e8
-  data.tar.gz: 5e631a6efa73d770ecafcb8b55278240f83f4ffb58702fbc7c6f48cd101e45ef
+  metadata.gz: a6ef12d9845a34ffde013cc03cc66f0d23a6d6b8dd65a0073c39ff89e2a58d1e
+  data.tar.gz: 1de91a3b2aa5c0ff8dda1a77887d02cf1a4d2b36608db6285863b05c5c4d1663
 SHA512:
-  metadata.gz: 057fcdb72061f64c1fd330722e958eb2680936756b861fb1d6777878e860cda2a645d050721e2d29f9518a2057bfaaf386d5d166938c9c4de1cb498cee83dd1e
-  data.tar.gz: 5f145c0cac07ae44eb0375aa62d68cf12bf0d1966d353eed205857f5e9d5d69ebe13387df2c44fd0b8914fc7ab34bbe9572e1192908df5452d2337f75ff1aa09
+  metadata.gz: 8c55a6febb5a5c1d7986f151e2849442d05799889d500fd72d7ea3713b9ef9b64b549c275dc134b357cd160f2b2dcb803f0b2ab8945d21635fd2c545d9ecb9e6
+  data.tar.gz: facb20fb48d76ec0bef375a09dc09b144b59ed773baf3720bfa5c955e01849c71d94a4d8c920bee35d5a8733f737cb8e1a8e396061e44ea2974f9786a3efe5dc

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

@@ -27,3 +27,11 @@ Include original error message when warning that a gem was unable to be loaded.
 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.

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.3'
+  gem 'devpack', '~> 0.2.0'
 end
 ```
 
@@ -32,19 +32,59 @@ 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.
 
 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

@@ -3,18 +3,46 @@
 require 'rubygems'
 require 'pathname'
 
+require 'devpack/timeable'
 require 'devpack/config'
 require 'devpack/gems'
 require 'devpack/gem_glob'
 require 'devpack/gem_path'
+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/gems.rb

@@ -3,6 +3,8 @@
 module Devpack
   # Loads requested gems from configuration
   class Gems
+    include Timeable
+
     def initialize(config)
       @config = config
     end
@@ -12,18 +14,12 @@ 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
     end
@@ -32,12 +28,18 @@ module Devpack
       update_load_path(name)
       [name, Kernel.require(name)]
     rescue LoadError => e
-      warn(Messages.failure_message(name, e))
+      warn(Messages.failure(name, load_error_message(e)))
       nil
     end
 
     def warn(message)
-      Kernel.warn("[devpack] #{message}")
+      Devpack.warn(message)
+    end
+
+    def load_error_message(error)
+      return "(#{error.message})" unless Devpack.debug?
+
+      %[(#{error.message})\n#{error.backtrace.join("\n")}]
     end
 
     def gem_glob

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,34 @@
 module Devpack
   # Generates output messages.
   class Messages
-    def self.failure_message(name, error)
-      base = "Failed to load `#{name}`"
-      install = "bundle exec gem install #{name}"
-      "#{base}. Try `#{install}` (#{error})"
-    end
+    class << self
+      def failure(name, error_message)
+        base = "Failed to load `#{name}`"
+        install = "bundle exec gem install #{name}"
+        "#{base}. Try `#{install}` #{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 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.3'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devpack
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-08-01 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
@@ -105,7 +105,10 @@ files:
 - lib/devpack/gem_glob.rb
 - lib/devpack/gem_path.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: