bundler-install_dash_docs 0.1.0-universal-darwin → 0.1.1-universal-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83327e5b8a5b5b9edd567bc4c15ef462e79ec0bbb50c0b8f71cd0d4ac9e53c75
-  data.tar.gz: 74acf93aaab6e169e0bcc3e79b9f2c9a76cb2d65b06ae9be6a394e023b38c8af
+  metadata.gz: d128363fd286e119d7f8f884ffa5d0a5861d0b99e9544be024a7edcfe7b81eaf
+  data.tar.gz: 102436bc68c25d633d1c63eb9e464b9347696313263a1f7d2ec88d7f67eb0f36
 SHA512:
-  metadata.gz: 659ffe45b856a624ff3d693f4fc8dc8ebaef077e09083ea6e8759f2bbe32cb84178fe67232063bdd5baf502d210d95a82984a7cd2624e35698a3f19fe23dc857
-  data.tar.gz: f5aec2f4868975502426b15e5c66f8b2e78731ae67c9079cf0eedbb3447224a982b30b35032f663da1782801753756c340fef2af266c8e3e9b007afba09c7835
+  metadata.gz: 93f41cc53478e5c6bd40bda2330cbb5720dc23e689f5a671725fcffe1d8651eedbd0419121506a9785d4a8644b9b10d39de32f69ad20b30e3567616db306ea6b
+  data.tar.gz: 7ad1bf0574d2c2aee764e0e1c4071a37c75e94baa86bc2f1e5a63a43c52de7d7ccd13775289957445c4fe66bf3b0adfa84d294fc78ca7353bc4ba2884129ed74

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.1.1] - 2022-03-05
+
+- Probably fixed the issues getting the bundler plugin system to work with this gem.
+
 ## [0.1.0] - 2022-03-04
 
 - Initial release. Invokes `dash-install://` for gems in the lockfile
+- Broken: cannot execute as a bundler plugin because bundler uses `exec`, but Thor uses `start`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bundler-install_dash_docs (0.1.0-universal-darwin)
+    bundler-install_dash_docs (0.1.1-universal-darwin)
       addressable (~> 2.2)
       thor (~> 1.2)
 

data/README.md

@@ -25,7 +25,9 @@ You probably want to install this at the system level, so it's available for any
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To test the bundler plugin command, after installing it on the local machine with `rake`, `bundle plugin install bundler-install_dash_docs` will work. Even if the plugin isn't installed, `bundle install_dash_docs` will work, because it uses the Thor CLI executable from your PATH directly.
+
+To release a new version, update the version number with `gem bump`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/bundler/install_dash_docs/bundler_plugin.rb

@@ -0,0 +1,18 @@
+require "bundler"
+
+module Bundler
+  module InstallDashDocs
+    ##
+    # Glue between Bundler Plugin system and Thor executable provided by the gem
+    class BundlerPlugin < ::Bundler::Plugin::API
+      command "install_dash_docs"
+
+      def exec(command_name, args)
+        # I do not know why https://bundler.io/v2.3/guides/bundler_plugins.html
+        # tells you to create a gem, use a Thor command, and then doesn't include docs
+        # on using that Thor command. However, this seems to be correct
+        CLI.start(args)
+      end
+    end
+  end
+end

data/lib/bundler/install_dash_docs/cli.rb

@@ -4,8 +4,6 @@ require "bundler"
 module Bundler
   module InstallDashDocs
     class CLI < ::Thor
-      ::Bundler::Plugin::API.command("install_dash_docs", self)
-
       desc "install", "Install docsets for all gems in this bundle into Dash.app"
       method_option :quiet, type: :boolean, default: false, aliases: "-q", desc: "Supresses normal output of the gem names and versions"
       method_option :dry_run, type: :boolean, default: false, aliases: "-n", desc: "Print out what would be performed, but do not install docsets in Dash"

data/lib/bundler/install_dash_docs/version.rb

@@ -2,6 +2,6 @@
 
 module Bundler
   module InstallDashDocs
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/bundler/install_dash_docs.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "install_dash_docs/version"
+require_relative "install_dash_docs/bundler_plugin"
 require_relative "install_dash_docs/cli"
 require_relative "install_dash_docs/dash"
 require_relative "install_dash_docs/dash_install_url"

data/plugins.rb

@@ -1 +1,2 @@
+# This file is loaded by bundler plugin subsystem, simply requiring gem's code is enough
 require "bundler/install_dash_docs"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bundler-install_dash_docs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: universal-darwin
 authors:
 - Dan Jackson
@@ -57,6 +57,7 @@ files:
 - bundler-install_dash_docs.gemspec
 - exe/bundler-install_dash_docs
 - lib/bundler/install_dash_docs.rb
+- lib/bundler/install_dash_docs/bundler_plugin.rb
 - lib/bundler/install_dash_docs/cli.rb
 - lib/bundler/install_dash_docs/dash.rb
 - lib/bundler/install_dash_docs/dash_install_url.rb