rigit 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587a5ce7b7cc4f78aed7b500eebc77d6a8cde3f0203dd662473bda17b6fd2dd4
-  data.tar.gz: 21317d234a17a214cc14cd4909916b91912beb4da5e72f99bf62becd8d7fd6c3
+  metadata.gz: ccfcfa55f8ac5a419d07a9936e7e0cfce9e736aa6a8e729f27c266e76aaa44d0
+  data.tar.gz: 7d83ac30e1574f5b78e8f6e48c22f98949e9e2d160dffa1c94f2ca536bd36505
 SHA512:
-  metadata.gz: 1589fb24b1c56af3bd893c381466bdc59bd81e946b4108554b0b3faca4e5f3f05057cd73de3cd36b5a1c0813bbca50363360496c3f11ae7918006360c18ae609
-  data.tar.gz: 86969745861ee54ec697c5429bd0523dffd21f07f89651cc1b01bb1c76fded36486544e009bac3bdfa51d75b0bd88c0cae41cb04c31f7db05d3dc25571e775e9
+  metadata.gz: d93c6c0fb5baff1d193f03bb1c896cf9f3fcfd222d49dae80fbceccf518ffb898dc39a99d49f8b9b2327f5f22416bf291cee218c0547410779463bf707aab213
+  data.tar.gz: c4a8ccc46524722846a6ccfa76c7a5271dfbfcef037dab46728fcee733e6ed1c37ce0a9671c2a8ef636229cb1f05cae3b89bb601520cb6823a7a2eed16cd85e8

data/README.md

@@ -28,7 +28,9 @@ Table of Contents
     * [Directory Structure](#directory-structure)
     * [Dynamic Tokens](#dynamic-tokens)
     * [Config File](#config-file)
-
+        * [`intro`](#intro)
+        * [`outro`](#outro)
+        * [`params`](#params)
 
 
 Installation
@@ -59,7 +61,7 @@ Usage
 ```
 $ rig
 Usage:
-  rig build RIG [PARAMS...]
+  rig build RIG [--force] [PARAMS...]
   rig install RIG REPO
   rig uninstall RIG
   rig update RIG
@@ -201,6 +203,8 @@ A typical config file looks like this:
 ```yaml
 intro: A sample generator
 
+outro: Something to say after scaffolding is done
+
 params:
   name:
     prompt: "Name your project:"
@@ -218,14 +222,33 @@ params:
     list: [irb, pry]
 ```
 
-| Key      | Purpose                                                 |
-|----------|---------------------------------------------------------|
-| `intro`  | A short message to display when building (Optional)     |
-| `params` | A list of parameters required by the rig                |
+#### `intro`
+
+A short optional message to display before building. 
+
+This string is displayed using the [Colsole][colsole] gem, so
+you can use [color markers][colsole-colors]
+
+Example: `intro: Welcome to my blue !txtblu!rig!txtrst!`
+
+
+#### `outro`
 
-The `params` key should start with the name of the variable (`name`, 
-`spec` and `console` in the above example), and contain the below 
-specifications:
+A short optional message to display after building.
+
+This string is displayed using the [Colsole][colsole] gem, so
+you can use [color markers][colsole-colors]
+
+Example: `outro: "!txtgrn!Thank you!txtrst!\nGoodbye."`
+
+
+#### `params`
+
+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:
 
 | Key       | Purpose                                                  |
 |-----------|----------------------------------------------------------|
@@ -237,3 +260,6 @@ specifications:
 ---
 
 [example-rig]: https://github.com/DannyBen/example-rig
+[colsole-colors]: https://github.com/dannyben/colsole#color-codes
+[colsole]: https://github.com/dannyben/colsole
+

data/lib/rigit/commands/build.rb

@@ -10,29 +10,30 @@ module Rigit::Commands
 
     # Internal class to handle scaffolding for the {CommandLine} class.
     class BuildHandler
-      attr_reader :args, :rig_name, :target_dir
+      attr_reader :args, :rig_name, :target_dir, :force
 
       include Colsole
 
       def initialize(args)
         @args = args
         @rig_name = args['RIG']
+        @force = args['--force']
         @target_dir = '.'
       end
 
       def execute
         say "Building !txtgrn!#{rig_name}"
-        say "!txtblu!#{config.intro}" if config.has_key? :intro
+        say config.intro if config.has_key? :intro
         verify_dirs
         arguments = prompt.get_input params
         rig.scaffold arguments:arguments, target_dir: target_dir do |file|
-          if File.exist? file
+          if File.exist? file and !force
             tty_prompt.yes? "Overwrite #{file}?", default: false
           else
             true
           end
         end
-        say "Done"
+        say config.has_key?(:outro) ? config.outro : "Done"
       end
 
       private

data/lib/rigit/docopt.txt

@@ -1,7 +1,7 @@
 Rigit
 
 Usage:
-  rig build RIG [PARAMS...]
+  rig build RIG [--force] [PARAMS...]
   rig install RIG REPO
   rig uninstall RIG
   rig update RIG
@@ -48,9 +48,19 @@ Parameters:
   SUBFOLDER
     A folder inside your rigs directory.
 
+Options:
+  -f --force
+    Overwrite existing files without prompting.
+
+  -h --help
+    Show this screen.
+
+  --version
+    Show version number.
+
 Environment Variables:
   RIG_HOME
-    The path where your local rigs are installed (default: ~/.rigs)
+    The path where your local rigs are installed (default: ~/.rigs).
 
 Examples:
   rig build gem name=mygem spec=y

data/lib/rigit/version.rb

@@ -1,3 +1,3 @@
 module Rigit
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rigit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_docopt