cli-mastermind 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a20b74d9d0e99c2d10a5f9c834be1ece3ffbecf8b5f978882c5fa165b7289316
-  data.tar.gz: af0406ca768e182e8243348a958adebac42f7640b6d497d2e990c0871d7aaee7
+  metadata.gz: 8db2ac9239f2def0778c23ee6a02f8e9955d4de5acfb1247e024a108ab4ac260
+  data.tar.gz: 3a532c3c20cb827a781852ab02062928bb5edb0408ffd3c02348c0b6175e2856
 SHA512:
-  metadata.gz: 7bba8a6c1e62ebf4adcd69075982396f4121422866f20f387396442c9e6f3607d67b09bab11bad462a093e137416359ff8ab14b39ff32bcf3d95be26262241fc
-  data.tar.gz: 0e713288d9930e8d7b7a1a872d120264d9b2a6e51792a5d37ac5d1cc7d32a619085d9cc9ca235ecbae85fd18c68a617eeb1e08659ece7273beabef6abc285141
+  metadata.gz: 9cb69d8818573049fca65ef43d2b83c6d4931ca69a2d98ff87ec1d36c6002f1c15c7f7bb45daa687e796bf3ff117a348883ff9203f055576f59dcb9a70dbb834
+  data.tar.gz: 2c24a20bedc2e188825393cc853da61e29668b78e6760cd378d10ff41a7a0716dbb857e08373d14ac5b53c59c4d29bd11c37c66027cac7a51f2b20ec3d83364b

data/lib/cli/mastermind.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'cli/ui'
 require 'cli/mastermind/arg_parse'
 require 'cli/mastermind/configuration'
@@ -12,12 +13,13 @@ module CLI
     extend Interface
 
     class << self
-      attr_reader :plans
-
+      # Expose the configuration loaded during +execute+.
       def configuration
         @config
       end
 
+      # Process incoming options and take an appropriate action.
+      # This is normally called by the mastermind executable.
       def execute(cli_args=ARGV)
         @arguments = ArgParse.new(cli_args)
 
@@ -25,36 +27,25 @@ module CLI
 
         frame('Mastermind') do
           @config = spinner('Loading configuration') { Configuration.new }
-          @plans = spinner('Loading plans') { @config.load_plans }
-          @plan_stack = []
 
-          @selected_plan = nil
+          if @arguments.dump_config?
+            do_print_configuration
+            exit 0
+          end
 
-          while @arguments.has_additional_plan_names?
-            plan_name = @arguments.get_next_plan_name
-            @selected_plan = (@selected_plan || @plans)[plan_name]
-            @plan_stack << titleize(plan_name)
+          @plans = spinner('Loading plans') { @config.load_plans }
 
-            if @selected_plan.nil?
-              puts "No plan found at #{@plan_stack.join('/')}"
-              puts @arguments.parser
-              exit 1
-            end
+          if @arguments.display_plans?
+            do_filtered_plan_display
+            exit 0
           end
 
-          # Prevent the prompt from exploading
-          if @selected_plan.nil? and @plans.count == 1
-            @selected_plan = @plans.values.first
-            @plan_stack << titleize(@selected_plan.name)
-          end
+          process_plan_names
 
-          while @selected_plan.nil? or @selected_plan.has_children?
-            do_interactive_plan_selection
-            @plan_stack << titleize(@selected_plan.name)
-          end
+          do_interactive_plan_selection until executable_plan_selected?
 
-          if !@arguments.ask? or confirm("Execute plan #{@plan_stack.join('/')}?")
-            @selected_plan.call(@arguments.plan_arguments)
+          if user_is_sure?
+            execute_plan!
           else
             puts 'aborted!'
           end
@@ -63,12 +54,122 @@ module CLI
 
       private
 
+      def do_print_configuration
+        frame('Configuration') do
+          fade_code = CLI::UI::Color.new(90, '').code
+          puts stylize("{{?}} #{fade_code}Values starting with {{*}} #{fade_code}were lazy loaded.#{CLI::UI::Color::RESET.code}")
+          print "\n"
+          @config.instance_variables.each do |attribute|
+            value = @config.instance_variable_get(attribute)
+
+            if value.respond_to? :call
+              if @arguments.resolve_callable_attributes?
+                value = begin
+                          value.call
+                        rescue => e
+                          "UNABLE TO LOAD: #{e.messae}"
+                        end
+              end
+
+              was_callable = true
+            else
+              was_callable = false
+            end
+
+            name = attribute.to_s.delete_prefix('@')
+
+            suffix = was_callable ? '{{*}}' : ' '
+
+            puts stylize("{{yellow:#{name}}}")
+            puts stylize("\t #{suffix} {{blue:#{value}}}")
+            print "\n"
+          end
+        end
+      end
+
+      def do_filtered_plan_display
+        filter_plans @arguments.pattern
+
+        unless @plans.empty?
+          frame('Plans') do
+            display_plans
+          end
+        else
+          puts stylize("{{x}} No plans match #{@arguments.pattern.source}")
+        end
+      end
+
+      def display_plans(plans=@plans, prefix='')
+        plans.each do |(name, plan)|
+          next unless plan.has_children? or plan.description
+
+          print prefix + '• '
+          puts stylize("{{yellow:#{titleize(name)}")
+          if plan.description
+            print prefix + '  - '
+            puts stylize("{{blue:#{plan.description}}}")
+          end
+
+          display_plans(plan.children, "  " + prefix) if plan.has_children?
+          print "\n"
+        end
+      end
+
+      def filter_plans(pattern, plans=@plans)
+        plans.keep_if do |name, plan|
+          # Don't display plans without a description or children
+          next false unless plan.has_children? or plan.description
+          next true if name =~ pattern
+          next false unless plan.has_children?
+
+          filter_plans(pattern, plan.children)
+
+          plan.has_children?
+        end
+      end
+
+      def process_plan_names
+        @plan_stack = []
+
+        @selected_plan = nil
+
+        while @arguments.has_additional_plan_names?
+          plan_name = @arguments.get_next_plan_name
+          @selected_plan = (@selected_plan || @plans)[plan_name]
+          @plan_stack << titleize(plan_name)
+
+          if @selected_plan.nil?
+            puts "No plan found at #{@plan_stack.join('/')}"
+            puts @arguments.parser
+            exit 1
+          end
+        end
+
+        # Prevent the prompt from exploading
+        if @selected_plan.nil? and @plans.count == 1
+          @selected_plan = @plans.values.first
+          @plan_stack << titleize(@selected_plan.name)
+        end
+      end
+
       def do_interactive_plan_selection
         options = @selected_plan&.children || @plans
 
         @selected_plan = select("Select a plan under #{@plan_stack.join('/')}", options: options)
+        @plan_stack << titleize(@selected_plan.name)
       end
 
+      def executable_plan_selected?
+        not (@selected_plan.nil? or @selected_plan.has_children?)
+      end
+
+      def user_is_sure?
+        !@arguments.ask? or confirm("Execute plan #{@plan_stack.join('/')}?")
+      end
+
+      def execute_plan!
+        @selected_plan.call(@arguments.plan_arguments)
+      end
     end
   end
 end

data/lib/cli/mastermind/arg_parse.rb

@@ -15,6 +15,8 @@ module CLI::Mastermind
       @initial_arguments = arguments
       @ask = true
       @display_ui = true
+      @show_config = false
+      @call_blocks = false
 
       parse_arguments
     end
@@ -39,6 +41,14 @@ module CLI::Mastermind
       @ask
     end
 
+    def dump_config?
+      @show_config
+    end
+
+    def resolve_callable_attributes?
+      @call_blocks
+    end
+
     def parser
       @parser ||= OptionParser.new do |opt|
         opt.banner = 'Usage: mastermind [--help, -h] [--plans[ PATTERN], --tasks[ PATTERN], -T [PATTERN], -P [PATTERN] [PLAN[, PLAN[, ...]]] -- [PLAN ARGUMENTS]'
@@ -56,12 +66,14 @@ module CLI::Mastermind
           @display_ui = false
         end
 
-        # TODO: Finish plan display
-        # opt.on('--plans [PATTERN]', '--tasks [PATTERN]', '-P [PATTERN]', '-T [PATTERN]',
-        #        [:text],
-        #        'Display plans.  Optional pattern is used to filter the returned plans.') do |pattern|
-        #   @pattern = RegExp.new(pattern || '*')
-        # end
+        opt.on('--plans [PATTERN]', '--tasks [PATTERN]', '-P', '-T', 'Display plans.  Optional pattern is used to filter the returned plans.') do |pattern|
+          @pattern = Regexp.new(pattern || '.')
+        end
+
+        opt.on('-C', '--show-configuration', 'Load configuration and print final values.  Give multiple times to resolve lazy attributes as well.') do
+          @call_blocks = @show_config
+          @show_config = true
+        end
       end
     end
 

data/lib/cli/mastermind/interface.rb

@@ -1,12 +1,19 @@
+# Wraps methods from CLI::UI in a slightly nicer DSL
+# @see https://github.com/Shopify/cli-ui
 module CLI::Mastermind::Interface
+  # Enables cli-ui's STDOUT Router for fancy UIs
   def enable_ui
     CLI::UI::StdoutRouter.enable
   end
 
+  # :private:
   def ui_enabled?
     CLI::UI::StdoutRouter.enabled?
   end
 
+  # Display a spinner with a +title+ while data is being loaded
+  # @returns the value of the given block
+  # @see https://github.com/Shopify/cli-ui#spinner-groups
   def spinner(title)
     return yield unless ui_enabled?
 
@@ -30,19 +37,40 @@ module CLI::Mastermind::Interface
     yield_value
   end
 
+  # Uses +CLI::UI.fmt+ to format a string
+  # @see https://github.com/Shopify/cli-ui#symbolglyph-formatting
+  def stylize(string)
+    CLI::UI.fmt string
+  end
+
+  # Opens a CLI::UI frame with the given +title+
+  # @see https://github.com/Shopify/cli-ui#nested-framing
   def frame(title)
     return yield unless ui_enabled?
     CLI::UI::Frame.open(title) { yield }
   end
 
+  # Ask the user for some text.
+  # @see https://github.com/Shopify/cli-ui#free-form-text-prompts
   def ask(question, default: nil)
     CLI::UI.ask(question, default: default)
   end
 
+  # Ask the user a yes/no +question+
+  # @see https://github.com/Shopify/cli-ui#interactive-prompts
   def confirm(question)
     CLI::UI.confirm(question)
   end
 
+  # Display an interactive list of options for the user to select.
+  #
+  # @param +question+ The question to ask the user
+  # @param +options:+ Array|Hash the options to display
+  # @param +default:+ The value or key to display first.  Defaults to the first option.
+  #
+  # Any other keyword arguments given are passed down into +CLI::UI::Prompt.ask+.
+  #
+  # @see https://github.com/Shopify/cli-ui#interactive-prompts
   def select(question, options:, default: options.first, **opts)
     default_value = nil
     options = case options
@@ -68,6 +96,15 @@ module CLI::Mastermind::Interface
     end
   end
 
+  # Titleize the given +string+.
+  # Replaces any dashes (-) or underscores (_) in the +string+ with spaces and
+  # then capitalizes each word.
+  #
+  # Examples:
+  #   titleize('foo') => 'Foo'
+  #   titleize('foo bar') => 'Foo Bar'
+  #   titleize('foo-bar') => 'Foo Bar'
+  #   titleize('foo_bar') => 'Foo Bar'
   def titleize(string)
     string.gsub(/[-_-]/, ' ').split(' ').map(&:capitalize).join(' ')
   end

data/lib/cli/mastermind/version.rb

@@ -8,7 +8,7 @@ module CLI
     module VERSION
       RELEASE = 0
       MAJOR = 0
-      MINOR = 1
+      MINOR = 2
       PATCH = nil
 
       STRING = [RELEASE, MAJOR, MINOR, PATCH].compact.join('.').freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-mastermind
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Chris Hall
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui