extended_bundler-errors 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: babe18203afe94da9da04ea703d4e66333764a4202b7c3d0385dc13ac0573a9d
-  data.tar.gz: c58c050aabcc9990511a5cec4721b210030ce925b4a2046318c033a93cd5ae1b
+  metadata.gz: ef86ec43e8663245ff3b5235c78b3b196f5adf0e24d50e51bf213b2ce5c89a2a
+  data.tar.gz: 37c869234b9ffac8082fed75e6281c8b7a4958e06281001a22fdf454f1370593
 SHA512:
-  metadata.gz: 97276b990723124ffd052ea12178efedfd17ec929e33c76691de445324d90f7e327a2f30053bfbf83610a9c4b61a3d24a628381f84b5f6d3838e6ec09c9d5a5a
-  data.tar.gz: 888187e9f737440a9655eab7fd5854f7169a24ae822c982fbf21396de5083c6a9442b452473660d8dc6e20fb2fc39fc919a5011e81bc89541f8b927ded2bddb0
+  metadata.gz: 3e117c4d6356d1841f11a13968fb94b815a3b05722ba1382b1f480fb1f360e02f550217749a9f0a485b66d81b28eb0da766d244541638f0d33d2039dc1479511
+  data.tar.gz: 40c7ce2b56bfd46f558fdfa60c613f60fefb3dd0c574b823158b266630a7426b6858881a4d90f274ddc530dc4e6306908fef2dd11db36d5f9492ca8d3645d8bb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    extended_bundler-errors (0.1.0)
+    extended_bundler-errors (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -8,7 +8,7 @@ These are hard to follow, particularly for people new to Ruby, because it requir
 
 This gem instead will try to match the output of the gem to a series of handlers (see `lib/extended_bundler/handlers` for a list). Each handler is specific to a gem, an matches one of many potential output. Once matched, we replace the error with something that explains the known problem, how to fix it, and (if possible) include a link to the original output.
 
-Here is an example:
+## Example
 
 Before when RMagick fails to install, you got a verbose log.
 
@@ -20,7 +20,7 @@ After when it fails to install you get a specific, actionable reason and step-by
 
 ## Installation
 
-While this is a gem, you need to install it as a plugin:
+While this is a gem, you need to install it as a [Bundler plugin](https://bundler.io/v1.16/guides/bundler_plugins.html):
 
 `bundler plugin install extended_bundler-errors`
 
@@ -38,6 +38,39 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Adding special handling for a bad error message
+
+Errors will happen so we want to make sure we can respond to them properly. Instead of finding an answer on StackOverflow or somewhere ese, let's make sure everyone in the future can get a better error message directly in their terminal during the install.
+
+To do this, you should:
+
+1. Create a file under [lib/extended_bundler/handlers](https://github.com/jules2689/extended_bundler-errors/tree/master/lib/extended_bundler/handlers) named "GEM_NAME.yml"
+2. Start with this template:
+```yaml
+-
+  versions: all
+  matching:
+   - "Matching Text"
+  messages:
+    en: |
+      My Message
+```
+3. Customize the template.
+
+#### Customizing the template
+
+There are a few keys to keep in mind:
+
+- `versions` can be the word `all` or a hash with `min` and/or `max` versions
+  - This is the versions to which the handler applies
+- `matching` is an array of strings (escapped regex is ok) that will be applied against the original bad error message
+  - You should find a unique string(s) that identifies a specific error
+- `messages` is a hash of messages that we might be able to give to a user
+  - `en` is required and is the default/English response
+  - Other language iso codes can be provided. Users will be given a response based on their `LANG` env var setting
+
+Note, this is an array of "matchers". We will try each one iteratively against the `GEM_NAME` until the first one matches. So if you have multiple handlers for a single gem, just continue expanding the yaml file.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/extended_bundler-errors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/extended_bundler/errors/version.rb

@@ -1,5 +1,5 @@
 module ExtendedBundler
   module Errors
-    VERSION = "0.1.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/extended_bundler/errors.rb

@@ -66,7 +66,7 @@ module ExtendedBundler
       end
 
       def build_error(spec_install, handler)
-        body = handler['message']
+        body = message(handler)
         # If we can pull out the original logs, add those to the message
         if log = spec_install.error.match(/Results logged to (?<message>.*)/)
           body += "\n{{bold:Original Logs are available at:}}\n" + log[:message]
@@ -79,6 +79,15 @@ module ExtendedBundler
         ExtendedBundler::Errors::Formatter.new(formatted_lines.join("\n")).format
       end
 
+      def message(handler)
+        # Grab the LANG environment variable
+        # Assume it's in Posix compliant ISO 15897 format (which is approx lang_region.encoding).
+        # Grab the lang out of that. If for some reason this isn't available, default back to
+        # English on any issue.
+        iso_15897_posix_lang = ENV.fetch('LANG', 'en').split('_').first
+        handler['messages'][iso_15897_posix_lang] || handler['messages']['en']
+      end
+
       def handler_path(gem_name)
         File.expand_path("../handlers/#{gem_name}.yml", __FILE__)
       end

data/lib/extended_bundler/handlers/http_parser.yml

@@ -2,15 +2,16 @@
   versions: all
   matching:
    - "ld: library not found for -lgmp"
-  message: |
-    You need to install developer tools for your system.
+  messages:
+    en: |
+      You need to install developer tools for your system.
 
-    One of the following commands may help:
+      One of the following commands may help:
 
-    Ubuntu:
-     - `apt-get install build-essential`
-     - `apt-get install libgmp-dev`
+      Ubuntu:
+       - `apt-get install build-essential`
+       - `apt-get install libgmp-dev`
 
-    Mac:
-     - `xcode-select --install`
-     - `brew uninstall gmp` and `brew install gmp`
+      Mac:
+       - `xcode-select --install`
+       - `brew uninstall gmp` and `brew install gmp`

data/lib/extended_bundler/handlers/mysql2.yml

@@ -0,0 +1,18 @@
+-
+  versions:
+    max: "0.5.0"
+  matching:
+   - use of undeclared identifier 'MYSQL_SECURE_AUTH'
+  messages:
+    en: |
+      {{bold:What is the problem?}}
+      The issue is {{underline:likely that the version of MySQL on your computer is incompatible.}}
+      This has more info: {{underline:https://github.com/brianmario/mysql2/issues/891}}
+
+      {{bold:Compatible versions of MySQL}}
+      - {{underline:MySQL 5.7.x}} and lower
+
+      {{bold:What can I do?}}
+      One of the following steps may help:
+      - install a compatible MySQL
+      - upgrade the mysql2 gem to at least 0.5.0

data/lib/extended_bundler/handlers/rmagick.yml

@@ -4,15 +4,16 @@
   matching:
    - Can't install RMagick [\d\.]+. Can't find MagickWand.h.
    - No package 'MagickCore' found
-  message: |
-    {{bold:What is the problem?}}
-    The issue is {{underline:likely that the version of Imagemagick on your computer is incompatible.}}
+  messages:
+    en: |
+      {{bold:What is the problem?}}
+      The issue is {{underline:likely that the version of Imagemagick on your computer is incompatible.}}
 
-    {{bold:Compatible versions of Imagemagick}}
-    - {{underline:ImageMagick 6.9.9-40}} and lower
+      {{bold:Compatible versions of Imagemagick}}
+      - {{underline:ImageMagick 6.9.9-40}} and lower
 
-    {{bold:What can I do?}}
-    One of the following steps may help:
-    - install a compatible Imagemagick
-    - upgrade RMagick
-    - use a different gem (like mini_magick)
+      {{bold:What can I do?}}
+      One of the following steps may help:
+      - install a compatible Imagemagick
+      - upgrade RMagick
+      - use a different gem (like mini_magick)

data/lib/extended_bundler/handlers/testing_stuff.yml

@@ -4,4 +4,6 @@
     max: 2.0
   matching:
    - "testing stuff only"
-  message: This is a message
+  messages:
+    en: |
+      This is a message

data/lib/extended_bundler/handlers/testing_stuff_2.yml

@@ -3,4 +3,6 @@
     min: 1.0
   matching:
    - "testing stuff only"
-  message: This is a message
+  messages:
+    en: |
+      This is a message

data/lib/extended_bundler/handlers/unf_ext.yml

@@ -2,17 +2,18 @@
   versions: all
   matching:
    - "ld: library not found for -lgmp"
-  message: |
-    {{bold:What is the problem?}}
-    You need to install developer tools for your system.
+  messages:
+    en: |
+      {{bold:What is the problem?}}
+      You need to install developer tools for your system.
 
-    {{bold:What can I do?}}
-    One of the following commands may help:
+      {{bold:What can I do?}}
+      One of the following commands may help:
 
-    {{italic:Ubuntu:}}
-     - {{command:apt-get install build-essential}}
-     - {{command:apt-get install libgmp-dev}}
+      {{italic:Ubuntu:}}
+       - {{command:apt-get install build-essential}}
+       - {{command:apt-get install libgmp-dev}}
 
-    {{italic:Mac:}}
-     - {{command:xcode-select --install}}
-     - {{command:brew uninstall gmp}} and {{command:brew install gmp}}
+      {{italic:Mac:}}
+       - {{command:xcode-select --install}}
+       - {{command:brew uninstall gmp}} and {{command:brew install gmp}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extended_bundler-errors
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - jules2689
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ files:
 - lib/extended_bundler/errors/formatter.rb
 - lib/extended_bundler/errors/version.rb
 - lib/extended_bundler/handlers/http_parser.yml
+- lib/extended_bundler/handlers/mysql2.yml
 - lib/extended_bundler/handlers/rmagick.yml
 - lib/extended_bundler/handlers/testing_stuff.yml
 - lib/extended_bundler/handlers/testing_stuff_2.yml