cli-mastermind 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f9d964ad9871b8f4b0b44fce7340487954d1fa00396fafa1c546be54673ced8
-  data.tar.gz: b1ca65e254ac504bdfdc3badde8964dd7f21321b3ef882f6546b7e8c97e94e12
+  metadata.gz: 3a932d12a8cc90bcdf962b0980e81a6ccb0e11b3c2be7545c62dd8c9de93be1d
+  data.tar.gz: 80ba0ee26a3ec8aa2f85cea56b1c62f982066a06608d12010b234cbdad90e514
 SHA512:
-  metadata.gz: ba400135252064d5ae3709c8759ffaac92b19f6c3f3cb55a4db8da99401a0c52becd4507ed075a9ca185bc28b96018eac7763397d8bfd9dd7cc96d4f5cd850d5
-  data.tar.gz: be4dbac7ae0e6d37fa76a55893e9a64c554081fff45bb6f4692e9f5fa22a581f0989ee4e5a0a3661c69f505d020aad0fe62d050187398be4d4fc08b263e03b0d
+  metadata.gz: f27becd1dcccb97e1ef7e4764e05711b09e1ef031a7e97c35100999992220dae941648751a522a8f8d0d556054d605622bf6f0238834dbecb4d63271f3034216
+  data.tar.gz: 4c60255fa408f8e73c602ab5e855623073b2430a65fcc4e578a4a4ee01a03b172d82dc1ba596798dff488ab9faff08896896ad6ee5e35b4176fb9ba0b4f1e2a6

data/README.md

@@ -1,32 +1,32 @@
 # Mastermind
 
-Mastermind is a CLI toolkit.  It's purpose is to help build, configure, and run
+Mastermind is a CLI framework.  It's purpose is to help build, configure, and run
 command line tools.
 
-Mastermind is designed for flexibility, extensibility, and minimal dependencies.
+Mastermind is designed for flexibility, extensibility, minimal dependencies.
 
 ## Flexibility
 
 Mastermind is written in Ruby and, therefore, provides first-class citizenship
-to that language and uses Ruby's syntax and semantics in its primary configuration
-files.
+to that language and uses Ruby's syntax and semantics in its configuration files.
 
-Mastermind looks for and executes `.masterplan` files recursively up the file tree
-until it reaches the root of your project, if defined, or your home directory,
+Mastermind looks for and evaluates `.masterplan` files recursively up the file
+tree until it reaches the root of your project, if defined, or your home directory,
 if it's not.  Additionally, it always looks for and attempts to load a `.masterplan`
 file in your home directory, if one exists.
 
 In this way, configuration for your tools can live where it makes the most sense
 for it to live with as much or as little duplication as you deem necessary.
 
-See [Writing Masterplans](#writing-masterplans) for more on their structure and semantics.
+See [Writing Masterplans][writing-masterplans] for more on their structure and
+semantics.
 
-Mastermind makes up for the lack of language flexibility in its configuration
-with full flexibility in its planfiles.  Which brings us to...
+Mastermind makes up for the lack of flexibility in its configuration with full
+flexibility in its planfiles.  Which brings us to...
 
 ## Extensibility
 
-Mastermind is designed from the outset to provide means of extending its planfile
+Mastermind is designed from the outset to provide a means of extending its planfile
 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.
@@ -35,11 +35,15 @@ As long as the objects returned by your loader quack like a `Plan`, Mastermind
 won't fuss at them.  After all, you can't take over the world if your busy mucking
 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.
+
 ## Minimal Dependencies
 
 Mastermind only has one dependency, Shopify's excelent [cli-ui project][cli-ui].
-It doesn't require that you load it in your Gemfile or do anything in particular.
-All you need to be able to do is run its executable and Mastermind does the rest.
+Mastermind doesn't require that you load it in your Gemfile or add anything to
+your project's configuration files.
 
 ## Usage
 
@@ -57,90 +61,8 @@ 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
-multiple plans on the command line is how you walk down the tree to a specific
-plan.
-
-### Writing Masterplans
-
-`.masterplan` files use a minimal DSL to configure Mastermind and load planfiles.
-Some of these commands have sensible defaults designed to keep configuration to
-a minimum.
-
-#### Masterplan DSL
-
-##### `project_root [directory]`
-
-Specifies the root of your project.  Must be specified to prevent Mastermind
-from scanning more of your filesystem than it needs to.  The easiest way to
-do this is to just specify it in a `.masterplan` file in the actual root of
-your project.
-
-Aliased as `at_project_root`.  The argument defaults to the directory of the
-current `.masterplan`.
-
-##### `plan_files [directory]`
-
-Specifies that plan files exist in the given directory.  Mastermind will search
-this directory for any files that end in a supported extension and mark them
-for loading.  By default, Mastermind only supports files with a `.plan` extension.
-
-Aliased as `has_plan_files`. The argument defaults to a `plans` directory in
-the same directory as the current `.masterplan`.
-
-##### `plan_file filename[, filename[, ...]]`
-
-Instructs Mastermind to load the planfiles located at the given filenames.
-
-##### `configure attribute [value] [&block]`
-
-Used to set arbitrary configuration options.  When a configuration option is
-set in multiple `.masterplan` files, the "closest" one to your invocation wins.
-In other words, since Mastermind reads `.masterplan` files starting in your
-current directory and working it's way "up" the hierarchy, the first `.masterplan`
-that specifies a configuration option "wins".
-
-When provided a block, the value is computed the first time the option is called
-for.  The block runs in the context of the `Configuration` object built up by
-all the loaded `.masterplan` files, so it has access to all previously set
-configuration options.
-
-The block is only executed once.  After that, the value is cached so that it
-doesn't need to be recomputed.
-
-If both a block and a value are given, the block is ignored and only the value
-is stored.
-
-##### `see_also filename`
-
-Instructs Mastermind to also load the configuration specified in `filename`.
-This file does _not_ have to be named `.masterplan` but _does_ have to conform
-to the syntax outlined here.
-
-### Writing Planfiles
-
-By default, planfiles use a very simple DSL that will feel familiar to anyone
-that's ever used Rake.  The biggest difference between Rake (and similar tools)
-and Mastermind is that Mastermind has no support for dependent tasks or parallel
-tasks.  If your workflow requires either of those things, Mastermind is probably
-not the tool you want to use.  Or, rather, not the _only_ tool you want to use.
-
-#### Planfile DSL
-
-##### `plot name &block`
-
-Creates a Plan that contains children with the given `name`.  This is similar
-to the `namespace` command in a Rakefile.  The Plans created inside the block
-are added as children of this Plan.
-
-##### `description text`
-
-Provides a description for the next Plan created.  Plans created with `plot`
-can also have descriptions.
-
-##### `plan name &block`
-
-Creates a Plan with the given name and sets the given block as its action.
-This block is passed the arguments from the command line and is run as a Plan.
+multiple plan names on the command line is how you walk down the tree to a
+specific plan.
 
 ## Development
 
@@ -161,4 +83,5 @@ 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
 [cli-ui]: https://github.com/shopify/cli-ui

data/lib/cli/mastermind.rb

@@ -144,12 +144,6 @@ module CLI
             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

data/lib/cli/mastermind/interface.rb

@@ -66,10 +66,14 @@ module CLI::Mastermind::Interface
   end
 
   # Display an interactive list of options for the user to select.
+  # If less than 2 options would be displayed, the default value is automatically
+  # returned.
   #
   # @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.
+  # @param +default:+ The default value for this question.  Defaults to the first
+  #                   option.  The default option is displayed first.  Assumed to
+  #                   exist within the given options.
   #
   # Any other keyword arguments given are passed down into +CLI::UI::Prompt.ask+.
   #
@@ -95,6 +99,8 @@ module CLI::Mastermind::Interface
                 options.dup.tap { |o| o.delete(default_text) }
               end
 
+    return default unless options.count > 0
+
     CLI::UI::Prompt.ask(question, **opts) do |handler|
       handler.option(default_text.to_s) { default }
 

data/lib/cli/mastermind/version.rb

@@ -8,7 +8,7 @@ module CLI
     module VERSION
       RELEASE = 0
       MAJOR = 1
-      MINOR = 0
+      MINOR = 1
       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.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Hall
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -19,7 +19,7 @@ dependencies:
         version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement