rigit 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c64487a87ae7122b0d47a53d3843b374beb6d3ae12ccf0cf171d83d0f68075e8
-  data.tar.gz: ca486b20b6ba0ba9af18c1d10c3254b352a2598226995d6decdb785f86ff7ae5
+  metadata.gz: 115d92a220f39a44c6ade5078aa76be9a7dc716361ea2926f85d1ba80c588354
+  data.tar.gz: f1446dd700308179e588082abfe736e9f48101468e687273158aa2285920547c
 SHA512:
-  metadata.gz: f3bff17c87022e3742de0fddc5e9616e63f5fc1c443751104db0c292fba7c3f4ff86b2c4793a8795c544a0660178144c0fa18ce96cfe95ac7f6fffef790874da
-  data.tar.gz: a976e1b1ae23a1c207964957725e05d2d00622f0b2d4407858d1d8e8fec92c048d3401b96001fec503da3f46fc238a4a052415f854f8becd294d2f8430b050b1
+  metadata.gz: 0c90c6ec8a808dea93f11f69c808719d792e1e10ae452aab7d9099b2b441ec1be6c27d68e92c7e194a03d15c1f85de6e400a90893f21699baeb593e7680b894f
+  data.tar.gz: 0f67a31c66197d9a0853582a36f1669a3fc3d032bbf85d809118fc1e330b9531569502071a60377c6c1f3df7178c55e778fa9139cfe3e5d2f9e8bd2b0d8667ee

data/README.md

@@ -28,11 +28,11 @@ Table of Contents
     * [Directory Structure](#directory-structure)
     * [Dynamic Tokens](#dynamic-tokens)
     * [Config File](#config-file)
-        * [Example Config](#example-config)
+        * [Example config](#example-config)
         * [Showing messages before/after scaffolding](#showing-messages-beforeafter-scaffolding)
         * [Executing commands before/after scaffolding](#executing-commands-beforeafter-scaffolding)
         * [Scaffolding parameters](#scaffolding-parameters)
-
+        * [Conditional parameters](#conditional-parameters)
 
 Installation
 --------------------------------------------------
@@ -210,7 +210,7 @@ Place a `config.yml` file at the root of your rig template. A config file
 is optional for rigs that do not have any variables.
 
 
-#### Example Config
+#### Example config
 
 The below config file example contains all the available options:
 
@@ -234,15 +234,16 @@ params:
     type: text
     default: project
 
-  spec: 
-    prompt: Include RSpec files?
+  console: 
+    prompt: Include interactive console?
     type: yesno
     default: yes
 
-  console:
+  console_type:
     prompt: "Select console:"
     type: select
     list: [irb, pry]
+    condition: console=yes
 ```
 
 #### Showing messages before/after scaffolding
@@ -284,15 +285,16 @@ after:
 The `params` option contains a list of parameters required by the rig.
 
 Each definition in the `params` key should start with the name of the 
-variable (`name`, `spec` and `console` in the above example), and contain 
-the below specifications:
+variable (`name`, `console` and `console_type` in the above example), and 
+contain the below specifications:
 
-| Key       | Purpose                                                  |
-|-----------|----------------------------------------------------------|
-| `prompt`  | The text to display when asking for user input           |
-| `type`    | The variable tyoe. Can be `yesno`, `text` or `select`    |
-| `default` | The default value. When using `yesno`, use `yes` or `no` |
-| `list`    | An array of allowed options (only used in `select` type) |
+| Key         | Purpose                                                  |
+|-------------|----------------------------------------------------------|
+| `prompt`    | The text to display when asking for user input           |
+| `type`      | The variable tyoe. Can be `yesno`, `text` or `select`    |
+| `default`   | The default value. When using `yesno`, use `yes` or `no` |
+| `list`      | An array of allowed options (only used in `select` type) |
+| `condition` | Optional `key=value`. See [conditional parameters](#conditional-parameters) below |
 
 Example:
 
@@ -304,6 +306,32 @@ params:
     default: project
 ```
 
+#### Conditional parameters
+
+You can configure some of the parameters to prompt the user for input based
+on his previous input.
+
+A condition is a simple `key=value` where `key` is a name of a parameter
+that is previously defined.
+
+In the below example, the `console_type` parameter will only be requested if
+the user has responded with `yes` to the `console` question.
+
+Example:
+
+```yaml
+params:
+  console: 
+    prompt: Include interactive console?
+    type: yesno
+    default: yes
+
+  console_type:
+    prompt: "Select console:"
+    type: select
+    list: [irb, pry]
+    condition: console=yes
+```
 ---
 
 [example-rig]: https://github.com/DannyBen/example-rig

data/lib/rigit/prompt.rb

@@ -18,6 +18,7 @@ module Rigit
     def get_input(prefill={})
       result = {}
       params.each do |key, spec|
+        next if skip_by_condition? spec, result
         result[key] = prefill.has_key?(key) ? prefill[key] : ask(spec)
       end
       result
@@ -41,6 +42,12 @@ module Rigit
       end
     end
 
+    def skip_by_condition?(spec, filled_values)
+      return unless spec.has_key? :condition
+      key, value = spec.condition.split '='
+      filled_values[key.to_sym] != value
+    end
+
     def prompt
       @prompt ||= TTY::Prompt.new
     end

data/lib/rigit/version.rb

@@ -1,3 +1,3 @@
 module Rigit
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rigit
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2018-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_docopt