rigit 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8076af9f15739de9c3b1fb2a14ec2cdf4294d231e71e7a145d4e6caf6c43eae
-  data.tar.gz: 7e02b86550c1f344cda505558a4cf85ed61bf5c5a211052f3f324a7b60db87a9
+  metadata.gz: 587a5ce7b7cc4f78aed7b500eebc77d6a8cde3f0203dd662473bda17b6fd2dd4
+  data.tar.gz: 21317d234a17a214cc14cd4909916b91912beb4da5e72f99bf62becd8d7fd6c3
 SHA512:
-  metadata.gz: bfe4ba68fe6c433e6111d6c2bf94c22b7f09c0f585147f8f262fff5f5fc4ad290e91aff5510b0d9e5d4e6ce657d288cdd6e3916d9a9d738dfd4cf8b2c2d4774e
-  data.tar.gz: 61441041f37c51e0d7c739a20e053f716d0335b3f120dd040710e2b0373740b652d5eab2bdce7b5ead38ac69c494555b47f7ceeb47decce59efce8a5479e9ce6
+  metadata.gz: 1589fb24b1c56af3bd893c381466bdc59bd81e946b4108554b0b3faca4e5f3f05057cd73de3cd36b5a1c0813bbca50363360496c3f11ae7918006360c18ae609
+  data.tar.gz: 86969745861ee54ec697c5429bd0523dffd21f07f89651cc1b01bb1c76fded36486544e009bac3bdfa51d75b0bd88c0cae41cb04c31f7db05d3dc25571e775e9

data/README.md

@@ -61,6 +61,7 @@ $ rig
 Usage:
   rig build RIG [PARAMS...]
   rig install RIG REPO
+  rig uninstall RIG
   rig update RIG
   rig info RIG
   rig list [SUBFOLDER]
@@ -165,6 +166,18 @@ There are two types of folders in a rig template.
 2. Conditional folders (`parameter=value`) - contents in these folders will
    only be copied if the user answerd `value` to the question `parameter`.
 
+A typical rig folder looks like this:
+
+    myrig
+    |-- base
+    |   |-- files
+    |   `-- and-folders
+    |-- param=y
+    |   |-- files
+    |   `-- and-folders
+    |-- param=n
+    `-- config.yml
+
 
 ### Dynamic Tokens
 

data/bin/rig

@@ -10,8 +10,11 @@ rescue Rigit::Exit => e
   say message unless message == 'Rigit::Exit'
   exit 1
 rescue Rigit::ConfigError => e
-  say "#{e.class} - #{e.message}"
+  say "!txtred!#{e.class} - #{e.message}"
   exit 1
+rescue Rigit::TemplateError => e
+  say "!txtred!#{e.class} - #{e.message}!txtrst!\nin !txtgrn!#{e.file}!txtrst!"
+  say "Are you escaping % characters as %%?" if e.message =~ /%/
 rescue TTY::Reader::InputInterrupt
   say "\nGoodbye"
   exit 1

data/lib/rigit/command_line.rb

@@ -1,20 +1,26 @@
+require 'fileutils'
+require 'colsole'
 require 'super_docopt'
+
 require 'rigit/version'
 
 require 'rigit/commands/build'
 require 'rigit/commands/info'
 require 'rigit/commands/install'
 require 'rigit/commands/list'
+require 'rigit/commands/uninstall'
 require 'rigit/commands/update'
 
 module Rigit
+  # Handles command line execution using docopt.
   class CommandLine < SuperDocopt::Base
     version VERSION
     docopt File.expand_path 'docopt.txt', __dir__
-    subcommands [:build, :install, :update, :info, :list]
+    subcommands [:build, :install, :uninstall, :update, :info, :list]
 
     include Commands::Build
     include Commands::Install
+    include Commands::Uninstall
     include Commands::Update
     include Commands::Info
     include Commands::List

data/lib/rigit/commands/build.rb

@@ -1,11 +1,14 @@
-require 'colsole'
-
 module Rigit::Commands
+  # The {Build} module provides the {#build} command for the {CommandLine}
+  # module.
   module Build
+
+    # The command line +build+ command.
     def build
       BuildHandler.new(args).execute
     end
 
+    # Internal class to handle scaffolding for the {CommandLine} class.
     class BuildHandler
       attr_reader :args, :rig_name, :target_dir
 

data/lib/rigit/commands/info.rb

@@ -1,11 +1,15 @@
-require 'colsole'
-
 module Rigit::Commands
+  # The {Info} module provides the {#info} command for the {CommandLine}
+  # module.
   module Info
+    
+    # The command line +info+ command.
     def info
       InfoHandler.new(args).execute
     end
 
+    # Internal class to handle the display of metadata about a rig for the 
+    # {CommandLine} class.
     class InfoHandler
       include Colsole
 

data/lib/rigit/commands/install.rb

@@ -1,12 +1,13 @@
-require 'fileutils'
-require 'colsole'
-
 module Rigit::Commands
+  # The {Install} module provides the {#install} command for the 
+  # {CommandLine} module.
   module Install
+    # The command line +install+ command.
     def install
       InstallHandler.new(args).execute
     end
 
+    # Internal class to handle rig installation for the {CommandLine} class.
     class InstallHandler
       include Colsole
 
@@ -36,7 +37,7 @@ module Rigit::Commands
           say "  !txtpur!rig build #{rig_name}\n"
         else
           # :nocov:
-          say "!txtred!Installation failed"
+          say "!txtred!Install failed"
           # :nocov:
         end
 

data/lib/rigit/commands/list.rb

@@ -1,11 +1,15 @@
-require 'colsole'
-
 module Rigit::Commands
+  # The {List} module provides the {#list} command for the {CommandLine}
+  # module.
   module List
+
+    # The command line +list+ command.
     def list
       ListHandler.new(args).execute
     end
 
+    # Internal class to handle listing of available rigs for the 
+    # {CommandLine} class.
     class ListHandler
       include Colsole
 

data/lib/rigit/commands/uninstall.rb

@@ -0,0 +1,67 @@
+module Rigit::Commands
+  # The {Uninstall} module provides the {#uninstall} command for the 
+  # {CommandLine} module.
+  module Uninstall
+    # The command line +uninstall+ command.
+    def uninstall
+      UninstallHandler.new(args).execute
+    end
+
+    # Internal class to handle rig removal for the {CommandLine} class.
+    class UninstallHandler
+      include Colsole
+
+      attr_reader :args, :rig_name
+
+      def initialize(args)
+        @args = args
+        @rig_name = args['RIG']
+      end
+
+      def execute
+        verify_dirs
+        uninstall
+      end
+
+      private
+
+      def uninstall
+        say "This will remove !txtgrn!#{rig_name}!txtrst! and delete\n#{target_path}"
+        continue = tty_prompt.yes? "Continue?", default: false
+        uninstall! if continue
+      end
+
+      def uninstall!
+        say "Uninstalling !txtgrn!#{rig_name}"
+        success = FileUtils.rm_rf target_path
+
+        if success
+          say "Rig uninstalled !txtgrn!successfully"
+        else
+          # :nocov:
+          say "!txtred!Uninstall failed"
+          # :nocov:
+        end
+      end
+
+      def rig
+        @rig ||= Rigit::Rig.new rig_name
+      end
+
+      def target_path
+        @target_path ||= rig.path
+      end
+
+      def tty_prompt
+        @tty_prompt ||= TTY::Prompt.new
+      end
+
+      def verify_dirs
+        if !rig.exist?
+          say "Rig !txtgrn!#{rig_name}!txtrst! is not installed"
+          raise Rigit::Exit
+        end
+      end
+    end
+  end
+end

data/lib/rigit/commands/update.rb

@@ -1,5 +1,3 @@
-require 'colsole'
-
 module Rigit::Commands
   module Update
     def update

data/lib/rigit/config.rb

@@ -2,9 +2,15 @@ require 'configatron/core'
 require 'yaml'
 
 module Rigit
+  # Handles the rig config file.
+  # Usage example: 
+  # 
+  #    Config.load 'path/to.yml'
+  #
   class Config
     attr_reader :path
 
+    # Returns a new +configatron+ instance, after loading from a YAML file.
     def self.load(path)
       new(path).settings
     end

data/lib/rigit/docopt.txt

@@ -3,6 +3,7 @@ Rigit
 Usage:
   rig build RIG [PARAMS...]
   rig install RIG REPO
+  rig uninstall RIG
   rig update RIG
   rig info RIG
   rig list [SUBFOLDER]
@@ -19,6 +20,9 @@ Commands:
   install
     Clone a remote rig git repository and install it locally.
 
+  uninstall
+    Remove an installed rig.
+
   update
     Update an installed rig to its latest version.
 
@@ -51,6 +55,7 @@ Environment Variables:
 Examples:
   rig build gem name=mygem spec=y
   rig install example https://github.com/DannyBen/example-rig.git
+  rig uninstall example
   rig update example
   rig info example
   rig list

data/lib/rigit/errors.rb

@@ -1,4 +1,14 @@
 module Rigit
   class Exit < StandardError; end
+
   class ConfigError < ArgumentError; end
+
+  class TemplateError < StandardError
+    attr_reader :file
+
+    def initialize(file, message='')
+      @file = file
+      super message
+    end
+  end
 end

data/lib/rigit/git.rb

@@ -1,9 +1,12 @@
 module Rigit
+  # A utility class that handles all +git+ operations.
   class Git
+    # Clones a git repo.
     def self.clone(repo, target_path)
       execute %Q[git clone #{repo} "#{target_path}"]
     end
 
+    # Pulls a git repo.
     def self.pull(target_path)
       Dir.chdir target_path do
         execute %Q[git pull]

data/lib/rigit/prompt.rb

@@ -1,6 +1,10 @@
 require 'tty-prompt'
 
 module Rigit
+  # Handles prompt request for user input in batch.
+  # This is a wrapper around +TTY::Prompt+ that gets all the params (typically
+  # from the rig config file), and asks the user for input one by one, while 
+  # considering prefilled values.
   class Prompt
     attr_reader :params
 
@@ -8,6 +12,9 @@ module Rigit
       @params = params
     end
 
+    # Asks the user for input. If a +prefill+ hash is provided, it will be
+    # used for values, and skip asking the user to provide answers for the
+    # ones that are prefilled.
     def get_input(prefill={})
       result = {}
       params.each do |key, spec|

data/lib/rigit/rig.rb

@@ -1,19 +1,27 @@
 module Rigit
+  # Handles "rigging" (scaffolding) of new projects from template rigs.
   class Rig
     attr_reader :name
 
+    # Returns the root path for all rigs. By default, it will be +~/.rigs+
+    # unless the +RIG_HOME+ environment variable is set.
     def self.home
       ENV['RIG_HOME'] ||= File.expand_path('.rigs', Dir.home)
     end
 
+    # Sets the +RIG_HOME+ environment variable, and the new root path for 
+    # rigs.
     def self.home=(path)
       ENV['RIG_HOME'] = path
     end
 
+    # Returns a new instance of Rig. The +name+ argument should be the name 
+    # of an existing (installed) rig.
     def initialize(name)
       @name = name
     end
 
+    # Builds the project from the template rig.
     def scaffold(arguments: {}, target_dir:'.', &block)
       scaffold_dir dir: "#{path}/base", arguments: arguments, 
         target_dir: target_dir, &block
@@ -27,26 +35,32 @@ module Rigit
       end
     end
 
+    # Returns the full path to the rig template.
     def path
       "#{Rig.home}/#{name}"
     end
 
+    # Returns true if the rig path exists.
     def exist?
       Dir.exist? path
     end
 
+    # Returns true if the rig has a +config.yml+ file. 
     def has_config?
       File.exist? config_file
     end
 
+    # Returns the path to the +config.yml+ file of the rig.
     def config_file
       "#{path}/config.yml"
     end
 
+    # Returns a +configatron+ instance.
     def config
       @config ||= Config.load(config_file)
     end
 
+    # Returns metadata about the rig, including all of its config values.
     def info
       {
         name: name,
@@ -65,7 +79,12 @@ module Rigit
 
         next if block_given? and !yield target_file
 
-        content = File.read(file) % arguments
+        begin
+          content = File.read(file) % arguments
+        rescue ArgumentError => e
+          raise TemplateError.new file, e.message
+        end
+        
         File.deep_write target_file, content
       end
     end

data/lib/rigit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rigit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-17 00:00:00.000000000 Z
+date: 2018-02-27 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/uninstall.rb
 - lib/rigit/commands/update.rb
 - lib/rigit/config.rb
 - lib/rigit/docopt.txt
@@ -216,7 +217,7 @@ files:
 - lib/rigit/prompt.rb
 - lib/rigit/rig.rb
 - lib/rigit/version.rb
-homepage: https://github.com/DannyBen/rigit
+homepage: https://dannyben.github.io/rigit/
 licenses:
 - MIT
 metadata: {}
@@ -236,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Zero-coding project scaffolding