rigit 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61bc7c4f474a82ed1c5a4c74696972482fbf5c583f0784cc842efeb6d74ffa63
-  data.tar.gz: ac7e0abb56fc7877c35ca670264e2a0aebc63a87b5e055d5e79f17ae4738d8eb
+  metadata.gz: c64487a87ae7122b0d47a53d3843b374beb6d3ae12ccf0cf171d83d0f68075e8
+  data.tar.gz: ca486b20b6ba0ba9af18c1d10c3254b352a2598226995d6decdb785f86ff7ae5
 SHA512:
-  metadata.gz: 6ae8b817dbdddfcfd36fad2b0b5a8ba7f9ba58e5a5cbc0cce261bde1645e01e83b1066c97c468ed3865718740bf0e8cc4c5aedd4a5992605a3434f46dfd55904
-  data.tar.gz: f0622b36f6c9d8d5d75a4a4b4c67d1717f265ab8775dba8ff1e32b25e7b15d32b7b93e9294c682796bb979414f1fd4f1412c984a04305864733b5d07fe6d3ed9
+  metadata.gz: f3bff17c87022e3742de0fddc5e9616e63f5fc1c443751104db0c292fba7c3f4ff86b2c4793a8795c544a0660178144c0fa18ce96cfe95ac7f6fffef790874da
+  data.tar.gz: a976e1b1ae23a1c207964957725e05d2d00622f0b2d4407858d1d8e8fec92c048d3401b96001fec503da3f46fc238a4a052415f854f8becd294d2f8430b050b1

data/README.md

@@ -28,9 +28,10 @@ Table of Contents
     * [Directory Structure](#directory-structure)
     * [Dynamic Tokens](#dynamic-tokens)
     * [Config File](#config-file)
-        * [`intro`](#intro)
-        * [`outro`](#outro)
-        * [`params`](#params)
+        * [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)
 
 
 Installation
@@ -61,6 +62,7 @@ Usage
 ```
 $ rig
 Usage:
+  rig new NAME
   rig build RIG [--force] [PARAMS...]
   rig install RIG REPO
   rig uninstall RIG
@@ -129,7 +131,7 @@ Most rigs will have parameters, you will be prompted to input them as needed.
 You can also provide some (or all) of the parameters in the command line, 
 if you need to avoid interactivity.
 
-    $ rig build example name=myapp spec=y console=irb license=MIT
+    $ rig build example name=myapp spec=yes console=irb license=MIT
 
 To learn about the parameters of a rig:
 
@@ -159,6 +161,10 @@ The steps in creating a rig are:
    a folder with s special `parameter=value` folder.
 5. Create a config file to specify the needed parameters.
 
+In order to quickly get started with creating a new rig, you can also run 
+`rig new your_new_rig_name`. This will create the initial folder structure
+and an initial `config.yml` for you to build on.
+
 
 ### Directory Structure
 
@@ -192,19 +198,36 @@ Tokens are specified using this syntax:
 
     %{name}
 
+If you are using the 
+[`before` and `after`](#showing-messages-beforeafter-scaffolding) 
+definitions in your config file, you can use dynamic tokens in both the 
+label and the command of each definition.
+
 
 ### Config File
 
 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.
 
-A typical config file looks like this:
+
+#### Example Config
+
+The below config file example contains all the available options:
 
 ```yaml
+# Optional messages to show before/after scaffolding
 intro: A sample generator
-
 outro: Something to say after scaffolding is done
 
+# Optional commands to execute before/after scaffolding
+before:
+  "Create empty .env file": "touch .env"
+
+after:
+  "Install Dependencies": "bundle install"
+  "Initialize git repo": "git init"
+
+# Parameters to collect on scaffolding
 params:
   name:
     prompt: "Name your project:"
@@ -222,29 +245,43 @@ params:
     list: [irb, pry]
 ```
 
-#### `intro`
+#### Showing messages before/after scaffolding
 
-A short optional message to display before building. 
+Use the `intro` and `outro` options to show short message that will be
+displayed before or after building. Both are optional.
 
-This string is displayed using the [Colsole][colsole] gem, so
+The message is displayed using the [Colsole][colsole] gem, so
 you can use [color markers][colsole-colors]
 
-Example: `intro: Welcome to my blue !txtblu!rig!txtrst!`
+Example:
 
+```yaml
+intro: Welcome to my blue !txtblu!rig!txtrst!`
+outro: Installation completed successfully
+```
 
-#### `outro`
+#### Executing commands before/after scaffolding
 
-A short optional message to display after building.
+Use the `before` and `after` options to specify one or more commands to
+run before or after building. Each command has a label and an action, and 
+both support [dynamic tokens](#dynamic-tokens), so you can use the input the user provided in 
+your commands.
 
-This string is displayed using the [Colsole][colsole] gem, so
-you can use [color markers][colsole-colors]
+Example:
 
-Example: `outro: "!txtgrn!Thank you!txtrst!\nGoodbye."`
+```yaml
+before:
+  "Create empty .env file": "touch .env"
 
+after:
+  "Install Dependencies": "bundle install"
+  "Initialize git repo": "git init"
+  "Run setup script": "myscript %{name}"
+```
 
-#### `params`
+#### Scaffolding parameters
 
-A list of parameters required by the rig.
+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 
@@ -257,6 +294,16 @@ the below specifications:
 | `default` | The default value. When using `yesno`, use `yes` or `no` |
 | `list`    | An array of allowed options (only used in `select` type) |
 
+Example:
+
+```yaml
+params:
+  name:
+    prompt: "Name your project:"
+    type: text
+    default: project
+```
+
 ---
 
 [example-rig]: https://github.com/DannyBen/example-rig

data/lib/rigit/command_line.rb

@@ -10,13 +10,14 @@ require 'rigit/commands/install'
 require 'rigit/commands/list'
 require 'rigit/commands/uninstall'
 require 'rigit/commands/update'
+require 'rigit/commands/new_rig'
 
 module Rigit
   # Handles command line execution using docopt.
   class CommandLine < SuperDocopt::Base
     version VERSION
     docopt File.expand_path 'docopt.txt', __dir__
-    subcommands [:build, :install, :uninstall, :update, :info, :list]
+    subcommands [:build, :install, :uninstall, :update, :info, :list, new: :new_rig]
 
     include Commands::Build
     include Commands::Install
@@ -24,5 +25,6 @@ module Rigit
     include Commands::Update
     include Commands::Info
     include Commands::List
+    include Commands::NewRig
   end
 end

data/lib/rigit/commands/build.rb

@@ -38,9 +38,23 @@ module Rigit::Commands
       # Call Rig#scaffold while checking each file to see if it should be
       # overwritten or not.
       def scaffold(arguments)
+        execute_actions config.before, arguments if config.has_key? :before
+        
         rig.scaffold arguments: arguments, target_dir: target_dir do |file|
           overwrite_file? file
         end
+
+        execute_actions config.after, arguments if config.has_key? :after
+      end
+
+      # Execute user-defined system commands. 
+      # Actions are expected to be provided as a hash (label=command) and
+      # both labels and commands accept string interpolation +%{tokens}+
+      def execute_actions(actions, arguments)
+        actions.each do |label, command|
+          say "!txtgrn!#{label}" % arguments
+          system command % arguments
+        end
       end
 
       # Check various scenarios to decide if the file should be overwritten
@@ -69,7 +83,7 @@ module Rigit::Commands
 
       def prompt_user_to_overwrite(file)
         say "File !txtgrn!#{file}!txtrst! already exists."
-        tty_prompt.expand "Overwrite?" do |menu|
+        tty_prompt.expand "  Overwrite?" do |menu|
           menu.choice key: 'y', name: 'overwrite',     value: true
           menu.choice key: 'n', name: 'skip',          value: false
           menu.choice key: 'a', name: 'overwrite all'  do @overwrite_all = true; true end

data/lib/rigit/commands/new_rig.rb

@@ -0,0 +1,43 @@
+module Rigit::Commands
+  # The {NewRIg} module provides the {#new_rig} command for the {CommandLine}
+  # module.
+  module NewRig
+    
+    # The command line +new+ command.
+    def new_rig
+      NewRigHandler.new(args).execute
+    end
+
+    # Internal class to handle the creation of a new rig template for the 
+    # {CommandLine} class.
+    class NewRigHandler
+      include Colsole
+
+      attr_reader :args, :name
+
+      def initialize(args)
+        @args = args
+        @name = args['NAME']
+      end
+
+      def execute
+        verify_presence
+        Rigit::Rig.create name
+        say "Rig template created in !txtgrn!#{rig.path}"
+      end
+
+      private
+
+      def rig
+        @rig ||= Rigit::Rig.new name
+      end
+
+      def verify_presence
+        if rig.exist?
+          say "Rig !txtgrn!#{name}!txtrst! already exists, choose a different name"
+          raise Rigit::Exit
+        end
+      end
+    end
+  end
+end

data/lib/rigit/docopt.txt

@@ -1,6 +1,7 @@
 Rigit
 
 Usage:
+  rig new NAME
   rig build RIG [--force] [PARAMS...]
   rig install RIG REPO
   rig uninstall RIG
@@ -10,6 +11,9 @@ Usage:
   rig (-h|--help|--version)
 
 Commands:
+  new
+    Create a new rig template.
+
   build
     Create a new project based on one of the installed rig templates.
     This command should be executed in an empty directory.
@@ -34,6 +38,9 @@ Commands:
     of subfolders (possibly rigs) inside it.
 
 Parameters:
+  NAME
+    The name of the new rig template.
+
   RIG
     The name of the source folder (installed rig).
 
@@ -69,4 +76,5 @@ Examples:
   rig update example
   rig info example
   rig list
+  rig new myrig
 

data/lib/rigit/rig.rb

@@ -15,6 +15,15 @@ module Rigit
       ENV['RIG_HOME'] = path
     end
 
+    # Create a new empty rig with a basic config file as a starting point.
+    def self.create(name)
+      target_dir = "#{home}/#{name}"
+      template_file = File.expand_path 'template_config.yml', __dir__
+      
+      FileUtils.mkdir_p "#{target_dir}/base"
+      FileUtils.cp template_file, "#{target_dir}/config.yml"
+    end
+
     # Returns a new instance of Rig. The +name+ argument should be the name 
     # of an existing (installed) rig.
     def initialize(name)

data/lib/rigit/template_config.yml

@@ -0,0 +1,21 @@
+intro: Optional intro message
+
+outro: Optional outro message
+
+params:
+  name:
+    prompt: "Name your project:"
+    type: text
+    default: project
+
+  # More parameter examples
+
+  # spec: 
+  #   prompt: Include RSpec files?
+  #   type: yesno
+  #   default: yes
+
+  # console:
+  #   prompt: "Select console:"
+  #   type: select
+  #   list: [irb, pry]

data/lib/rigit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rigit
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_docopt
@@ -207,6 +207,7 @@ files:
 - lib/rigit/commands/info.rb
 - lib/rigit/commands/install.rb
 - lib/rigit/commands/list.rb
+- lib/rigit/commands/new_rig.rb
 - lib/rigit/commands/uninstall.rb
 - lib/rigit/commands/update.rb
 - lib/rigit/config.rb
@@ -216,6 +217,7 @@ files:
 - lib/rigit/git.rb
 - lib/rigit/prompt.rb
 - lib/rigit/rig.rb
+- lib/rigit/template_config.yml
 - lib/rigit/version.rb
 homepage: https://dannyben.github.io/rigit/
 licenses: