rigit 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 115d92a220f39a44c6ade5078aa76be9a7dc716361ea2926f85d1ba80c588354
-  data.tar.gz: f1446dd700308179e588082abfe736e9f48101468e687273158aa2285920547c
+  metadata.gz: dd2a2c78d7c9698965042e42736818edfbf35b015ee4e5f76fbf410dd0c6d4e4
+  data.tar.gz: c88d8463c4992fc279cf579a0cc1422f71ebd875e58631e25d940991d88a0708
 SHA512:
-  metadata.gz: 0c90c6ec8a808dea93f11f69c808719d792e1e10ae452aab7d9099b2b441ec1be6c27d68e92c7e194a03d15c1f85de6e400a90893f21699baeb593e7680b894f
-  data.tar.gz: 0f67a31c66197d9a0853582a36f1669a3fc3d032bbf85d809118fc1e330b9531569502071a60377c6c1f3df7178c55e778fa9139cfe3e5d2f9e8bd2b0d8667ee
+  metadata.gz: 766579f3d737a555cc26a8e4f47f9480f969d0938f15d8f94d6582f1b66d8cbc3fe2dd82a1dafa193c19ebdd1591a45a18768db9ba8bb0fc96bed170b184917b
+  data.tar.gz: fd7b722589b4b7f46cb25d414b75f939ed316288cb3a37f258391e5a692893694f087d95af782152241770afe53fa0a9e18d034437a30299b232a88b3f05546f

data/README.md

@@ -33,6 +33,7 @@ Table of Contents
         * [Executing commands before/after scaffolding](#executing-commands-beforeafter-scaffolding)
         * [Scaffolding parameters](#scaffolding-parameters)
         * [Conditional parameters](#conditional-parameters)
+        * [Calculated parameters](#calculated-parameters)
 
 Installation
 --------------------------------------------------
@@ -244,8 +245,13 @@ params:
     type: select
     list: [irb, pry]
     condition: console=yes
+
+  uppercase_name:
+    type: ruby
+    code: input[:name].upcase
 ```
 
+
 #### Showing messages before/after scaffolding
 
 Use the `intro` and `outro` options to show short message that will be
@@ -261,6 +267,7 @@ intro: Welcome to my blue !txtblu!rig!txtrst!`
 outro: Installation completed successfully
 ```
 
+
 #### Executing commands before/after scaffolding
 
 Use the `before` and `after` options to specify one or more commands to
@@ -280,6 +287,7 @@ after:
   "Run setup script": "myscript %{name}"
 ```
 
+
 #### Scaffolding parameters
 
 The `params` option contains a list of parameters required by the rig.
@@ -288,13 +296,14 @@ Each definition in the `params` key should start with the name of the
 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) |
-| `condition` | Optional `key=value`. See [conditional parameters](#conditional-parameters) below |
+ Key         | Purpose                                                      
+-------------|--------------------------------------------------------------
+ `prompt`    | The text to display when asking for user input
+ `type`      | The variable tyoe. Can be `yesno`, `text`, `select` or `ruby`
+ `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
+ `code`      | A ruby code to evaluate (only used in `ruby` type). See [calculated parameters](#calculated-parameters) below
 
 Example:
 
@@ -306,6 +315,7 @@ params:
     default: project
 ```
 
+
 #### Conditional parameters
 
 You can configure some of the parameters to prompt the user for input based
@@ -332,6 +342,33 @@ params:
     list: [irb, pry]
     condition: console=yes
 ```
+
+
+#### Calculated parameters
+
+You can define a parameter that is calculated with a piece of ruby code.
+
+This parameter may or may not use values from previous input parameters.
+
+In the below example, the `constant_name` parameter will be the uppercase
+version of the `name` parameter:
+
+Example:
+
+```yaml
+params:
+  name:
+    type: ruby
+    code: |
+      "bob"
+
+  constant_name:
+    type: ruby
+    code: |
+      input[:name].upcase
+```
+
+
 ---
 
 [example-rig]: https://github.com/DannyBen/example-rig

data/lib/rigit/commands/build.rb

@@ -135,11 +135,11 @@ module Rigit::Commands
       end
 
       def verify_target_dir
-        if !Dir.empty? target_dir
-          dirstring = target_dir == '.' ? 'Current directory' : "Directory '#{target_dir}'"
-          continue = tty_prompt.yes? "#{dirstring} is not empty. Continue anyway?", default: false
-          raise Rigit::Exit, "Goodbye" unless continue
-        end
+        return if Dir.empty?(target_dir) or force
+
+        dirstring = target_dir == '.' ? 'Current directory' : "Directory '#{target_dir}'"
+        continue = tty_prompt.yes? "#{dirstring} is not empty. Continue anyway?", default: false
+        raise Rigit::Exit, "Goodbye" unless continue
       end
     end
   end

data/lib/rigit/prompt.rb

@@ -6,7 +6,7 @@ module Rigit
   # from the rig config file), and asks the user for input one by one, while 
   # considering prefilled values.
   class Prompt
-    attr_reader :params
+    attr_reader :params, :input
 
     def initialize(params)
       @params = params
@@ -16,12 +16,12 @@ module Rigit
     # used for values, and skip asking the user to provide answers for the
     # ones that are prefilled.
     def get_input(prefill={})
-      result = {}
+      @input = {}
       params.each do |key, spec|
-        next if skip_by_condition? spec, result
-        result[key] = prefill.has_key?(key) ? prefill[key] : ask(spec)
+        next if skip_by_condition? spec
+        @input[key] = prefill.has_key?(key) ? prefill[key] : ask(spec)
       end
-      result
+      @input
     end
 
     private
@@ -37,15 +37,17 @@ module Rigit
         prompt.ask text, default: default
       when 'select'
         prompt.select text, param.list, marker: '>'
+      when 'ruby'
+        instance_eval param.code
       else
         raise ConfigError, "Unknown type '#{param[:type]}'"
       end
     end
 
-    def skip_by_condition?(spec, filled_values)
+    def skip_by_condition?(spec)
       return unless spec.has_key? :condition
       key, value = spec.condition.split '='
-      filled_values[key.to_sym] != value
+      input[key.to_sym] != value
     end
 
     def prompt

data/lib/rigit/version.rb

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

metadata

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