cli-mastermind 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14bea90e61e0acaf588c50485fc37947c376b5778d9a7e8752b948a540d94f44
-  data.tar.gz: cdd0b63de45746a2b5df33e72245b20037adcf89665bb98c2c5200f58de2c3c1
+  metadata.gz: 9078a8e331150ebe62b1ecf44270422c93855b869510f34d57e983895a3b7fcf
+  data.tar.gz: c7bb2f6a630aa6b62319e409f238b88a1a81a4baa3a8e76737b1290e15efd2fc
 SHA512:
-  metadata.gz: 29adefa5c6f7a489071af7c726671788b8a3d38b37c4d7af5d53cd24346bc9a2a319fb5fd526734902182d9c06dfa0fae3550d7514cc9e51b534d20b775be03d
-  data.tar.gz: cafc5940e66d5a756251aa09ec43cc1cb141111eb59be05d145f909db6f3c6a50b391aaf3315abce85ac757ae713ab298e51f47e002bf8c66f3341a4f65460bb
+  metadata.gz: 1ec54b9f8e61defa6dd76c40cdd6d46fbba1afb6e173e47f25e0042ed69b7ca4ae32d4dd75ca924af55c22f4a10e2f4f22d2ab907f71abac789e9b08248ed7f9
+  data.tar.gz: ef03260db00aa0062ed9514ae5bd6e201274d89778dccafa1f74b94c1bf2566665513e4ae4fd638b1c717e1586990275d3c4786a3952b721d6bd74849c3a4554

data/lib/cli/mastermind.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+require 'forwardable'
 require 'cli/ui'
 require 'cli/mastermind/arg_parse'
 require 'cli/mastermind/configuration'
@@ -104,34 +105,44 @@ module CLI
 
         unless @plans.empty?
           frame('Plans') do
-            display_plans
+            puts build_display_string
           end
         else
           puts stylize("{{x}} No plans match #{@arguments.pattern.source}")
         end
       end
 
-      def display_plans(plans=@plans, prefix='')
+      def build_display_string(plans=@plans, prefix='')
         fade_code = CLI::UI::Color.new(90, '').code
+        reset     = CLI::UI::Color::RESET.code
+
+        display_string = ''
 
         plans.each do |(name, plan)|
           next unless plan.has_children? or plan.description
 
-          print prefix + '• '
-          puts stylize("{{yellow:#{titleize(name)} #{fade_code}(#{name})#{CLI::UI::Color::RESET.code}")
+          display_string += prefix + '• '
+          display_string += stylize("{{yellow:#{titleize(name)} #{fade_code}(#{name})#{reset}\n")
 
           if plan.aliases.any?
-            puts prefix + "  - #{fade_code}aliases: #{plan.aliases.to_a.join(', ')}#{CLI::UI::Color::RESET.code}"
+            display_string += prefix + "  - #{fade_code}aliases: #{plan.aliases.to_a.join(', ')}#{reset}\n"
           end
 
           if plan.description
-            print prefix + '  - '
-            puts stylize("{{blue:#{plan.description}}}")
+            display_string += prefix + '  - '
+            display_string += stylize("{{blue:#{plan.description}}}\n")
           end
 
-          display_plans(plan.children, "  " + prefix) if plan.has_children?
-          print "\n"
+          if plan.has_children?
+            display_string += "\n"
+            display_string += build_display_string(plan.children, "  " + prefix)
+          end
+
+          display_string += "\n"
         end
+
+        # Collapse any run of three or more newlines into just two
+        display_string.gsub(/\n{3,}/, "\n\n")
       end
 
       def filter_plans(pattern, plans=@plans)

data/lib/cli/mastermind/configuration.rb

@@ -15,6 +15,8 @@ module CLI
     # _last_.  You can use this to specify plans you want accessible everywhere
     # or global configuration that should apply everywhere (unless overridden by
     # more specific masterplans).
+    #
+    # @see Configuration::DSL
     class Configuration
       # Filename of masterplan files
       PLANFILE = '.masterplan'
@@ -144,6 +146,10 @@ module CLI
         end
       end
 
+      # Describes the DSL used in masterplan files.
+      #
+      # See the .masterplan file in the root of this repo for a full example of
+      # the available options.
       class DSL
         def initialize(config, filename)
           @config = config
@@ -154,26 +160,48 @@ module CLI
         # Specifies that another masterplan should also be loaded when loading
         # this masterplan.  NOTE: This _immediately_ loads the other masterplan.
         def see_also(filename)
-          @config.load_masterplan(filename)
+          @config.load_masterplan(File.expand_path(filename))
         end
 
-        # With no arguments, specifies that the current directory containing this
-        # masterplan is at the root of your project.  Otherwise, specifies the root
-        # of the project.
-        def project_root(root = File.dirname(@filename))
+        # Specifies the root of the project.
+        # +root+ must be a directory.
+        def project_root(root)
+          unless Dir.exist? root
+            raise InvalidDirectoryError.new('Invalid project root', root)
+          end
+
           @config.project_root = root
         end
-        alias_method :at_project_root, :project_root
 
-        # With no arguments, specifies that plans exist in a /plans/ directory
-        # under the directory the masterplan is in.
-        def plan_files(directory = File.join(File.dirname(@filename), 'plans'))
-          @config.add_plans(Dir.glob(File.join(directory, '**', "*{#{supported_extensions}}")))
+        # Syntactic sugar on top of `project_root` to specify that the current
+        # masterplan resides in the root of the project.
+        def at_project_root
+          project_root File.dirname(@filename)
+        end
+
+        # Specify that plans exist in the given +directory+.
+        # Must be a valid directory
+        def plan_files(directory)
+          unless Dir.exist? directory
+            raise InvalidDirectoryError.new('Invalid plan file directory', directory)
+          end
+
+          planfiles = Dir.glob(File.join(directory, '**', "*{#{supported_extensions}}"))
+          planfiles.map! { |file| File.expand_path(file) }
+
+          @config.add_plans(planfiles)
+        end
+
+        # Syntactic sugar on top of `plan_files` to specify that plans exist in
+        # a +plans/+ directory in the current directory.
+        def has_plan_files
+          plan_files File.join(File.dirname(@filename), 'plans')
         end
-        alias_method :has_plan_files, :plan_files
 
         # Specifies that a specific plan file exists at the given +filename+.
         def plan_file(*files)
+          files = files.map { |file| File.expand_path file }
+
           @config.add_plans(files)
         end
 

data/lib/cli/mastermind/errors.rb

@@ -11,5 +11,11 @@ module CLI
 
     class InvalidPlanError < Error
     end
+
+    class InvalidDirectoryError < Error
+      def initialize(message, directory)
+        super "#{message}:  #{directory} does not exist or is not a directory"
+      end
+    end
   end
 end

data/lib/cli/mastermind/loader/planfile_loader.rb

@@ -13,6 +13,8 @@ module CLI::Mastermind
       private
 
       class DSL
+        extend Forwardable
+
         attr_reader :plans
 
         def initialize(filename=nil, &block)
@@ -50,6 +52,12 @@ module CLI::Mastermind
         def set_alias(alias_to)
           @plans.last.add_alias(alias_to)
         end
+
+        # Delegate configuration to the top-level configuration object
+        # Planfile loading happens well after configuration has been loaded. So,
+        # we can safely rely on it being setup at this point.
+        def_delegator :'CLI::Mastermind', :configuration
+        alias_method :config, :configuration
       end
     end
   end

data/lib/cli/mastermind/plan.rb

@@ -1,4 +1,3 @@
-require 'forwardable'
 require 'cli/mastermind/plan/interface'
 
 module CLI

data/lib/cli/mastermind/version.rb

@@ -7,8 +7,8 @@ module CLI
 
     module VERSION
       RELEASE = 0
-      MAJOR = 5
-      MINOR = 1
+      MAJOR = 6
+      MINOR = 0
       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.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Chris Hall
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2019-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui