cli-mastermind 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a932d12a8cc90bcdf962b0980e81a6ccb0e11b3c2be7545c62dd8c9de93be1d
-  data.tar.gz: 80ba0ee26a3ec8aa2f85cea56b1c62f982066a06608d12010b234cbdad90e514
+  metadata.gz: 6b685a85669b39aaaf6f66c502c3705f6c3927fb93b719ca511ec1f5ad504b32
+  data.tar.gz: dd4403bde3e61c28288e4f17e8b7b8f9aa408c15a39e62ff40e73044581d751d
 SHA512:
-  metadata.gz: f27becd1dcccb97e1ef7e4764e05711b09e1ef031a7e97c35100999992220dae941648751a522a8f8d0d556054d605622bf6f0238834dbecb4d63271f3034216
-  data.tar.gz: 4c60255fa408f8e73c602ab5e855623073b2430a65fcc4e578a4a4ee01a03b172d82dc1ba596798dff488ab9faff08896896ad6ee5e35b4176fb9ba0b4f1e2a6
+  metadata.gz: 0e75a90c7e61ba882085ab1efd9044ee58eb1b6e8f1225314f3449646be530656e5fba2a266f62d2b285c9de688202d674d03cf6520019059cc1f63161cdcec1
+  data.tar.gz: ed1cee7f906e6ae8983f8b4d75e8c59650c6ed5528aa2cb6a5aeb703ccda2266d06accf35d9a31ff827d0ce8015e41a1aedc5bba27780c6df4221722ce0047e3

data/README.md

@@ -5,6 +5,10 @@ command line tools.
 
 Mastermind is designed for flexibility, extensibility, minimal dependencies.
 
+## My devious plot cannot wait!  Tell me your secrets!
+
+If you want to jump right into using Mastermind, head over to the [wiki][wiki].
+
 ## Flexibility
 
 Mastermind is written in Ruby and, therefore, provides first-class citizenship
@@ -39,6 +43,9 @@ Obviously, it'd be a bit difficult to write your plan files in an entirely separ
 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.
 
+If you are writing your plans in Ruby, Mastermind provides `CLI::Mastermind::Plan::Interface`
+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].
@@ -60,10 +67,13 @@ Any arguments specified after `--` are passed as-is down to the executed plan.
 You can then process those arguments however you like or ignore them completely!
 
 Unlike Rake and other, similar, tools that allow you to run multiple tasks in
-parallel, Mastermind is designed to run only one task at a time.  Specifying
+parallel, _Mastermind is designed to run only one task at a time_.  Specifying
 multiple plan names on the command line is how you walk down the tree to a
 specific plan.
 
+For more information on how to use and configure Mastermind, check out the
+[wiki][wiki].
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can
@@ -83,5 +93,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/chall8
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-[writing-masterplans]: wiki/Writing-Masterplans
+[wiki]: https://github.com/chall8908/cli-mastermind/wiki
+[writing-masterplans]: https://github.com/chall8908/cli-mastermind/wiki/Writing-Masterplans
 [cli-ui]: https://github.com/shopify/cli-ui

data/lib/cli/mastermind.rb

@@ -3,14 +3,14 @@ require 'cli/ui'
 require 'cli/mastermind/arg_parse'
 require 'cli/mastermind/configuration'
 require 'cli/mastermind/errors'
-require 'cli/mastermind/interface'
+require 'cli/mastermind/user_interface'
 require 'cli/mastermind/loader'
 require 'cli/mastermind/plan'
 require 'cli/mastermind/version'
 
 module CLI
   module Mastermind
-    extend Interface
+    extend UserInterface
 
     class << self
       # Expose the configuration loaded during +execute+.

data/lib/cli/mastermind/plan.rb

@@ -1,24 +1,15 @@
 require 'forwardable'
+require 'cli/mastermind/plan/interface'
 
 module CLI
   module Mastermind
     class Plan
-      extend Forwardable
+      include UserInterface
       include Interface
 
-      # The name of the plan.  Used to specify the plan from the command line
-      # or from the interactive menu
-      attr_reader :name
-
-      # Displayed in the non-interactive list of available plans
-      attr_reader :description
-
       # Used in the interactive plan selector to display child plans
       attr_reader :children
 
-      # The file this plan was loaded from, if any
-      attr_reader :filename
-
       # Loads a particular plan from the filesystem.
       # @see Loader
       def self.load(filename)
@@ -28,10 +19,8 @@ module CLI
       end
 
       def initialize(name, description=nil, filename=nil, &block)
-        @name = name.to_s.freeze
-        @description = description.freeze
-        @filename = filename
-        @block = block
+        super
+
         @children = {}
       end
 
@@ -75,7 +64,9 @@ module CLI
           end
 
           # Otherwise, the plan defined later wins and overwrites the existing plan
-          warn <<~PLAN_COLLISON.strip
+
+          # Warn the user that this is happening, unless we're running tests.
+          warn <<~PLAN_COLLISON.strip unless defined? RSpec
                  Plan name collision encountered when loading plans from "#{plan.filename}" that cannot be merged.
                  "#{plan.name}" was previously defined in "#{existing_plan.filename}".
                  Plans from "#{plan.filename}" will be used instead.
@@ -84,10 +75,6 @@ module CLI
 
         @children[plan.name] = plan
       end
-
-      # Delegate configuration to the top-level configuration object
-      def_delegator :'CLI::Mastermind', :configuration
-      alias_method :config, :configuration
     end
   end
 end

data/lib/cli/mastermind/plan/interface.rb

@@ -0,0 +1,49 @@
+module CLI::Mastermind
+  class Plan
+    # The plan interface is everything that is required in order for an object
+    # to be usable as a plan.
+    #
+    # Objects adhering to this interface must implement their own +call+ method.
+    # This method is what is invoked by Mastermind to execute a plan.
+    #
+    # Mastermind assumes that any plan it encounters could have children, hence
+    # the +has_children?+ method here.  Since the default PlanfileLoader doesn't
+    # permit custom plan classes when defining a plan with children, it's assumed
+    # that any custom plans (which include this interface) won't have any children
+    # at all.
+    module Interface
+      extend Forwardable
+
+      def self.included(base)
+        # The name of the plan.  Used to specify the plan from the command line
+        # or from the interactive menu
+        base.attr_reader :name
+
+        # Displayed in the non-interactive list of available plans
+        base.attr_reader :description
+
+        # The file this plan was loaded from, if any
+        base.attr_reader :filename
+      end
+
+      def initialize(name, description=nil, filename=nil, &block)
+        @name = name.to_s.freeze
+        @description = description.freeze
+        @filename = filename
+        @block = block
+      end
+
+      def has_children?
+        false
+      end
+
+      def call(options=nil)
+        raise NotImplementedError
+      end
+
+      # Delegate configuration to the top-level configuration object
+      def_delegator :'CLI::Mastermind', :configuration
+      alias_method :config, :configuration
+    end
+  end
+end

data/lib/cli/mastermind/{interface.rb → user_interface.rb}

@@ -1,6 +1,6 @@
 # Wraps methods from CLI::UI in a slightly nicer DSL
 # @see https://github.com/Shopify/cli-ui
-module CLI::Mastermind::Interface
+module CLI::Mastermind::UserInterface
   # Enables cli-ui's STDOUT Router for fancy UIs
   def enable_ui
     CLI::UI::StdoutRouter.enable

data/lib/cli/mastermind/version.rb

@@ -7,8 +7,8 @@ module CLI
 
     module VERSION
       RELEASE = 0
-      MAJOR = 1
-      MINOR = 1
+      MAJOR = 2
+      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.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Hall
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -77,10 +77,11 @@ files:
 - lib/cli/mastermind/arg_parse.rb
 - lib/cli/mastermind/configuration.rb
 - lib/cli/mastermind/errors.rb
-- lib/cli/mastermind/interface.rb
 - lib/cli/mastermind/loader.rb
 - lib/cli/mastermind/loader/planfile_loader.rb
 - lib/cli/mastermind/plan.rb
+- lib/cli/mastermind/plan/interface.rb
+- lib/cli/mastermind/user_interface.rb
 - lib/cli/mastermind/version.rb
 homepage: https://github.com/chall8908/cli-mastermind
 licenses: