cli-mastermind 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c548ef96d5f0b89113a1110cae2deae76be3c15fd4380727fe74c84bcda29766
-  data.tar.gz: f189bc224bc60e7ee496b5704df921b3cfd0d37ecb831990889c2666305628b8
+  metadata.gz: cd49841f87237f2a7223cd748c61772244232e84cdf46112241e291e73f1a311
+  data.tar.gz: '0197b2452f75c1c1c7ac50d84621a9dfef1635d04781c500fb4ca8516f2b65e5'
 SHA512:
-  metadata.gz: cc898bb8b3ade138634ebd11fbcd6ab830c60e874528759acbbf9c95ba42b2db7a7d66551d34de8f379a74842bdf2850c2e81860cd66310cddcab86a49ce591c
-  data.tar.gz: b2f01d7795e3b1ec527d1d3e74ab53b8f9fe250c4e647c7af004b2569b92a463ba11254d136eceb14fe06ea6c8963dd857ffbfc58075bec00a3d5e7963d0eb58
+  metadata.gz: b3f195e375e769c105e335c29ab33102db1b2ad76b963f6f463f9c77e0d25a6b79bced05eb44cc86eccaa8d32701236d10b73854310955f8f50742cbeb76a7ac
+  data.tar.gz: a5e649e5427b3bea7e52e6cb1a12fa3e563d5e54fbf405623c2d2cdb58147c89dab6043d8fabb3351bf70c13174b0c4c5827383cf75fea0270665847c4a2a3a0

data/README.md

@@ -26,11 +26,11 @@ See [Writing Masterplans][writing-masterplans] for more on their structure and
 semantics.
 
 Mastermind makes up for the lack of flexibility in its configuration with full
-flexibility in its planfiles.  Which brings us to...
+flexibility in its plan files.  Which brings us to...
 
 ## Extensibility
 
-Mastermind is designed from the outset to provide a means of extending its planfile
+Mastermind is designed from the outset to provide a means of extending its plan file
 formats through custom `Loader`s.  In fact, Mastermind's own `PlanfileLoader` is
 the first of such loaders.  You can specify your own file extensions and provide
 your own loaders as needed.
@@ -41,14 +41,14 @@ about in the details!
 
 Obviously, it'd be a bit difficult to write your plan files in an entirely separate
 language, but there's nothing stopping you from delegating actions to another
-executable or even writing some C code to call into something else alltogether.
+executable or even writing some C code to call into something else altogether.
 
-If you are writing your plans in Ruby, Mastermind provides `CLI::Mastermind::Plan::Interface`
+If you are writing your plans in Ruby, Mastermind provides `CLI::Mastermind::Plan`
 which you can include in your plans to provide the basic `Plan` interface.
 
 ## Minimal Dependencies
 
-Mastermind only has one dependency, Shopify's excelent [cli-ui project][cli-ui].
+Mastermind only has one dependency, Shopify's excellent [cli-ui project][cli-ui].
 Mastermind doesn't require that you load it in your Gemfile or add anything to
 your project's configuration files.
 

data/lib/cli/mastermind.rb

@@ -18,7 +18,7 @@ module CLI
     class << self
       # Expose the configuration loaded during +execute+.
       def configuration
-        @config
+        @config ||= spinner('Loading configuration') { Configuration.new @base_path }
       end
 
       # Allows utilities wrapping Mastermind to specify that only plans under a
@@ -41,15 +41,11 @@ module CLI
         enable_ui if @arguments.display_ui?
 
         frame('Mastermind') do
-          @config = spinner('Loading configuration') { Configuration.new @base_path }
-
           if @arguments.dump_config?
             do_print_configuration
             exit 0
           end
 
-          @plans = spinner('Loading plans') { @config.load_plans }
-
           if @arguments.display_plans?
             do_filtered_plan_display
             exit 0
@@ -67,22 +63,61 @@ module CLI
         end
       end
 
+      # Look up a specific plan by its name
+      #
+      # Because plans also implement this method in a compatible way, there are
+      # three ways this method could be used:
+      #
+      #  1. List of arguments
+      #    * Mastermind['name', 'of', 'plans']
+      #
+      #  2. Space separated string
+      #    * Mastermind['name of plans']
+      #
+      #  3. Hash-like access
+      #    * Mastermind['name']['of']['plans']
+      #
+      # All will provide the same plan.
+      #
+      # ---
+      #
+      # GOTCHA: Be careful if your plan name includes a space!
+      #
+      # While it's entirely valid to have a plan name that inlcudes a space, you
+      # should avoid them if you plan to look up your plan using this method.
+      #
+      def [](*plan_stack)
+        # Allow for a single space-separated string
+        if plan_stack.size == 1 and plan_stack.first.is_a?(String)
+          plan_stack = plan_stack.first.split(' ')
+        end
+
+        plan_stack.compact.reduce(plans) do |plan, plan_name|
+          plan[plan_name]
+        end
+      end
+
       private
 
+      def plans
+        @plans ||= spinner('Loading plans') { Loader.load_all configuration.plan_files }
+      end
+
       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)
+
+          configuration.instance_variables.each do |attribute|
+            value = configuration.instance_variable_get(attribute)
 
             name = attribute.to_s.sub(/^@/, '')
 
             if value.respond_to? :call
               if @arguments.resolve_callable_attributes?
                 value = begin
-                          @config.send(name)
+                          configuration.send(name)
                         rescue => e
                           "UNABLE TO LOAD: #{e.message}"
                         end
@@ -105,7 +140,7 @@ module CLI
       def do_filtered_plan_display
         filter_plans @arguments.pattern
 
-        unless @plans.empty?
+        unless plans.empty?
           frame('Plans') do
             puts build_display_string
           end
@@ -114,7 +149,7 @@ module CLI
         end
       end
 
-      def build_display_string(plans=@plans, prefix='')
+      def build_display_string(plans=self.plans, prefix='')
         fade_code = CLI::UI::Color.new(90, '').code
         reset     = CLI::UI::Color::RESET.code
 
@@ -147,7 +182,7 @@ module CLI
         display_string.gsub(/\n{3,}/, "\n\n")
       end
 
-      def filter_plans(pattern, plans=@plans)
+      def filter_plans(pattern, plans=self.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
@@ -161,13 +196,13 @@ module CLI
       end
 
       def process_plan_names
-        @arguments.do_command_expansion!(@config)
+        @arguments.do_command_expansion!(configuration)
 
         @arguments.insert_base_plan!(@base_plan) unless @base_plan.nil?
 
         @plan_stack = []
 
-        @selected_plan = @plans if @arguments.has_additional_plan_names?
+        @selected_plan = plans if @arguments.has_additional_plan_names?
 
         while @arguments.has_additional_plan_names?
           plan_name = @arguments.get_next_plan_name
@@ -184,7 +219,7 @@ module CLI
       end
 
       def do_interactive_plan_selection
-        options = (@selected_plan&.children || @plans).map { |k,v| [titleize(k.to_s), v] }.to_h
+        options = (@selected_plan&.children || plans).map { |k,v| [titleize(k.to_s), v] }.to_h
 
         @selected_plan = select("Select a plan under #{@plan_stack.join('/')}", options: options)
         @plan_stack << titleize(@selected_plan.name)
@@ -195,7 +230,7 @@ module CLI
       end
 
       def user_is_sure?
-        !@arguments.ask? or !@config.ask? or confirm("Execute plan #{@plan_stack.join('/')}?")
+        !@arguments.ask? or !configuration.ask? or confirm("Execute plan #{@plan_stack.join('/')}?")
       end
 
       def execute_plan!

data/lib/cli/mastermind/configuration.rb

@@ -24,7 +24,7 @@ module CLI
       # Path to the top-level masterplan
       MASTER_PLAN = File.join(Dir.home, PLANFILE)
 
-      attr_reader :plans
+      attr_reader :plan_files
 
       # Adds an arbitrary attribute given by +attribute+ to the configuration class
       def self.add_attribute(attribute)
@@ -73,31 +73,6 @@ module CLI
         @plan_files.merge(allowed_plans)
       end
 
-      # Loads all plan files added using +add_plans+
-      # @see Plan.load
-      def load_plans
-        @plans = Loader.load_all(@plan_files)
-      end
-
-      def execute_plan(*plan_stack, arguments: nil)
-        if plan_stack.size == 1
-          case plan_stack.first
-          when Array
-            plan_stack = plan_stack.first
-          when String
-            plan_stack = plan_stack.first.split(' ')
-          end
-        end
-
-        plan = @plans
-
-        plan_stack.each do |plan_name|
-          plan = plan[plan_name]
-        end
-
-        plan.call(arguments)
-      end
-
       # Loads a masterplan using the DSL, if it exists and hasn't been loaded already
       def load_masterplan filename
         if File.exists? filename and !@loaded_masterplans.include? filename
@@ -126,6 +101,12 @@ module CLI
 
       private
 
+      def method_missing(symbol, *args)
+        super
+      rescue NoMethodError
+        raise MissingConfigurationError, symbol
+      end
+
       # Walks up the file tree looking for masterplans.
       def lookup_and_load_masterplans
         load_masterplan File.join(Dir.pwd, PLANFILE)

data/lib/cli/mastermind/errors.rb

@@ -17,5 +17,11 @@ module CLI
         super "#{message}:  #{directory} does not exist or is not a directory"
       end
     end
+
+    class MissingConfigurationError < Error
+      def initialize(attribute)
+        super "#{attribute} has not been defined.  Call `configure :#{attribute}[, value]` in a `#{Configuration::PLANFILE}` to set it."
+      end
+    end
   end
 end

data/lib/cli/mastermind/plan.rb

@@ -48,6 +48,7 @@ module CLI
       def call(options=nil)
         raise NotImplementedError
       end
+      alias_method :execute, :call
 
       def add_alias(alias_to)
         config.define_alias(alias_to.to_s, name)

data/lib/cli/mastermind/version.rb

@@ -6,8 +6,8 @@ module CLI
     end
 
     module VERSION
-      RELEASE = 0
-      MAJOR = 7
+      RELEASE = 1
+      MAJOR = 0
       MINOR = 0
       PATCH = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-mastermind
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Hall
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Mastermind is a framework for constructing command line toolboxes.