coach 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c085b582900931acb9b56a21ee03e9b8b1695e8b9e36c23b5286acb8cc949868
-  data.tar.gz: ab1dd0c12bfcbad8b93832649f96fa3699cc036d392129f4b6e1e8aca36bb72e
+  metadata.gz: b69c1a3041e520ebf876b90ce472ab23c579fa93fe53c69692a6d3c0e553d918
+  data.tar.gz: ba41cb38a04d6756e5153383010173a353211ce31bdcf19df82d62c808647db8
 SHA512:
-  metadata.gz: 94525ce01d5c1b0dc75314c47f2901bdd33946fbe63ae847bf0ce6f1a1099e57c1db72f1c146199d0f77462eca826f47d0784aa21eeab41fb8b30aee3aa3dc0c
-  data.tar.gz: ccd13d3dcb3623c01f6650ce6efb842c892663afaaffa30db8e8781380a8ffcdbc9be809b0d171c224d7c494448cabf7b38d9dae989af1a0c5256bee1a949758
+  metadata.gz: e4480d684b2ed592ebd33ee1b5463fc5a981fabd50805e3575da99be51950b962fae5265bdc4a08d1ec2837a39509c22b3e6b95198b1d3705a4fa1590b3599fe
+  data.tar.gz: 4f5e2c69d1b4ae613ae030f859580546bd7d364d9df421b546bce5aaeffdf899a8d48c397a8bc6b9a545d88540703752e0b475a6b3092df4e898bc53ade013c1

data/CHANGELOG.md

@@ -4,7 +4,11 @@
 
 No unreleased changes.
 
-# 2.2.0 / 2019-01-08
+# 2.2.1 / 2020-02-06
+
+* [#85](https://github.com/gocardless/coach/pull/85) Uses [commander](https://github.com/commander-rb/commander) for CLI option parsing
+
+# 2.2.0 / 2020-01-08
 
 * [#68](https://github.com/gocardless/coach/pull/68) Add `coach` CLI and add
   documentation to README
@@ -135,4 +139,3 @@ consistent with other libraries. The previous names will work for now, but will
 
 Initial public release. This library is in beta until it hits 1.0, so backwards
 incompatible changes may be made in minor version releases.
-

data/bin/coach

@@ -1,57 +1,95 @@
 #!/usr/bin/env ruby
 
-require "slop"
 require "coach/cli/provider_finder"
+require "commander"
 
-begin
-  require File.join(Dir.pwd, "config/environment")
-rescue LoadError
-  puts <<~EOS
-    Could not load your Rails app
-    =============================
+module Coach
+  class CLI
+    extend Commander::Methods
 
-    Currently the coach CLI assumes you have a config/environment.rb file that
-    we can load. We believe this is true of Rails apps in general.
+    class << self
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def run
+        program :version, Coach::VERSION
+        program :description,
+                "Coach's CLI to help understand the provide/require graph made up of " \
+                "all the middleware chains you've built using Coach.\n" \
+                "  More information at: https://github.com/gocardless/coach#coach-cli."
+        program :help_formatter, :compact
 
-    Please raise an issue if that's not the case!
+        never_trace!
 
-    https://github.com/gocardless/coach/issues
-  EOS
-  exit 1
-end
+        command "find-provider" do |c|
+          c.syntax = "bundle exec coach find-provider"
+          c.description =
+            "Given the name of a Coach middleware and a value that it requires, it " \
+            "outputs the name of the middleware that provides it."
 
-Slop.parse do
-  command "find-provider" do
-    run do |_, args|
-      middleware_name, value_name = *args
-      raise ArgumentError, "middleware_name and value_name required" unless middleware_name && value_name
+          c.action do |args, _|
+            load_config_environment
 
-      result = Coach::Cli::ProviderFinder.new(args[0], args[1]).find_provider
+            middleware_name, value_name = *args
+            raise ArgumentError, "middleware_name and value_name required" unless middleware_name && value_name
 
-      puts "Value `#{value_name}` is provided to `#{middleware_name}` by:\n\n"
-      puts result.to_a.join("\n")
-    end
-  end
+            result = Coach::Cli::ProviderFinder.new(args[0], args[1]).find_provider
+
+            puts "Value `#{value_name}` is provided to `#{middleware_name}` by:\n\n"
+            puts result.to_a.join("\n")
+          end
+        end
+
+        command "find-chain" do |c|
+          c.syntax = "bundle exec coach find-chain"
+          c.description =
+            "Given the name of a Coach middleware and a value it requires, " \
+            "it outputs the chains of middleware between the specified middleware " \
+            "and the one that provides the required value."
+
+          c.action do |args, _|
+            load_config_environment
+
+            middleware_name, value_name = *args
+            raise ArgumentError, "middleware_name and value_name required" unless middleware_name && value_name
 
-  command "find-chain" do
-    run do |_, args|
-      middleware_name, value_name = *args
-      raise ArgumentError, "middleware_name and value_name required" unless middleware_name && value_name
+            chains = Coach::Cli::ProviderFinder.new(middleware_name, value_name).find_chain
 
-      chains = Coach::Cli::ProviderFinder.new(middleware_name, value_name).find_chain
+            if chains.size > 1
+              puts "Value `#{value_name}` is provided to `#{middleware_name}` " \
+                "by multiple middleware chains:\n\n"
+            else
+              puts "Value `#{value_name}` is provided to `#{middleware_name}` by:\n\n"
+            end
 
-      if chains.size > 1
-        puts "Value `#{value_name}` is provided to `#{middleware_name}` " \
-          "by multiple middleware chains:\n\n"
-      else
-        puts "Value `#{value_name}` is provided to `#{middleware_name}` by:\n\n"
+            formatted_chains = chains.map do |chain|
+              chain.join(" -> ")
+            end.join("\n---\n")
+
+            puts formatted_chains
+          end
+        end
+
+        run!
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+      def load_config_environment
+        require File.join(Dir.pwd, "config/environment")
+      rescue LoadError
+        puts <<~ERR
+          Could not load your Rails app
+          =============================
 
-      formatted_chains = chains.map do |chain|
-        chain.join(" -> ")
-      end.join("\n---\n")
+          Currently the coach CLI assumes you have a config/environment.rb file that
+          we can load. We believe this is true of Rails apps in general.
 
-      puts formatted_chains
+          Please raise an issue if that's not the case!
+
+          https://github.com/gocardless/coach/issues
+        ERR
+        exit 1
+      end
     end
   end
 end
+
+Coach::CLI.run

data/coach.gemspec

@@ -21,9 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "actionpack", ">= 4.2"
   spec.add_dependency "activesupport", ">= 4.2"
-  # TODO: Find another CLI parser that supports subcommands
-  # Slop v4 got rid of them :(
-  spec.add_dependency "slop", "~> 3.6"
+  spec.add_dependency "commander", "~> 4.5"
 
   spec.add_development_dependency "gc_ruboconfig", "= 2.9.0"
   spec.add_development_dependency "pry", "~> 0.10"

data/lib/coach/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coach
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coach
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: gc_ruboconfig
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +185,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Alternative controllers built with middleware