rigit 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7cf02dbda94c59314045bd5f4c719320435151593cb59cdb4d0a602b3579ff6
-  data.tar.gz: be15ad5aeb1a65fa2bb03cb13384d0bd704885c53126ec7993939862eb8ea4a7
+  metadata.gz: 24849e982806b052f0852e0ef6cc392e527a2e08a51ab1c38ab0cb94c58a5903
+  data.tar.gz: 5a23c1af45686400e6211997f9fa72c7c17391235f69c11d789a29f13805a655
 SHA512:
-  metadata.gz: d924611d858e1cf1d9f58fbad5e1badfecc16373ddcba6d009706ab93e93d6296b9ce4a4d582a1b007338fdd217233731699f0beac75cacc170478c032c36d6c
-  data.tar.gz: a6b43764932d58e1688b1fda82339cb27bf34cc044855cffc1d3658bb15860f6194bda463791cc0ed7a0812ffc9b2637fd208c42184fffd742c04420b4ef8458
+  metadata.gz: 89fd132a363d1a21673b12f7bdc275a16b9b4928a8c7f305de1463e5dfe2f34e99790688d91e06b5604a38e6bd37004a92dc1b46ab6ce5a9f1f14f9d553989e9
+  data.tar.gz: c92d7f4a103e44d3f660b0497798db6357046187ba62b56b8063dd66ad33654902561f10748255a0ce97eed06ede396b4b9cfe5a96725be70d0c0a305a6ea010

data/README.md

@@ -273,7 +273,7 @@ you can use [color markers][colsole-colors]
 Example:
 
 ```yaml
-intro: Welcome to my blue !txtblu!rig!txtrst!`
+intro: Welcome to my blue b`rig`
 outro: Installation completed successfully
 ```
 

data/bin/rig

@@ -10,12 +10,12 @@ rescue Rigit::Exit => e
   say message unless message == 'Rigit::Exit'
   exit 1
 rescue Rigit::ConfigError => e
-  say "!txtred!#{e.class} - #{e.message}"
+  say "r`#{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 =~ /%/
+  say "r`#{e.class} - #{e.message}`\nin g`#{e.file}`"
+  say 'Are you escaping % characters as %%?' if e.message.include?('%')
 rescue TTY::Reader::InputInterrupt
   say "\nGoodbye"
   exit 1
-end
+end

data/lib/rigit/command_line.rb

@@ -17,7 +17,7 @@ module Rigit
   class CommandLine < SuperDocopt::Base
     version VERSION
     docopt File.expand_path 'docopt.txt', __dir__
-    subcommands [:build, :install, :uninstall, :update, :info, :list, new: :new_rig]
+    subcommands [:build, :install, :uninstall, :update, :info, :list, { new: :new_rig }]
 
     include Commands::Build
     include Commands::Install

data/lib/rigit/commands/build.rb

@@ -2,7 +2,6 @@ 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
@@ -23,23 +22,23 @@ module Rigit::Commands
       end
 
       def execute
-        say "Building !txtgrn!#{rig_name}"
+        say "Building g`#{rig_name}`"
         say config.intro if config.has_key? :intro
         verify_dirs
         arguments = prompt.get_input params
 
         scaffold arguments
 
-        say config.has_key?(:outro) ? config.outro : "Done"
+        say config.has_key?(:outro) ? config.outro : 'Done'
       end
 
-      private
+    private
 
       # 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
@@ -47,12 +46,12 @@ module Rigit::Commands
         execute_actions config.after, arguments if config.has_key? :after
       end
 
-      # Execute user-defined system commands. 
+      # 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
+          say "g`#{label}`" % arguments
           system command % arguments
         end
       end
@@ -60,7 +59,7 @@ module Rigit::Commands
       # Check various scenarios to decide if the file should be overwritten
       # or not. These are the scenarios covered by this method:
       # 1. The user provided +--focce+ in the command line
-      # 2. The user answered "overwrite all" or "skip all" when he asked 
+      # 2. The user answered "overwrite all" or "skip all" when he asked
       #    about the first conflicting file.
       # 3. In cases where an additive dir contains a file that was originally
       #    new, approved or rejected - we use this existing knowledge (which
@@ -70,7 +69,7 @@ module Rigit::Commands
 
         response_log[file] = true
 
-        unless overwrite_all or force
+        unless overwrite_all || force
           if skip_all
             response_log[file] = false
           elsif File.exist? file
@@ -82,12 +81,18 @@ module Rigit::Commands
       end
 
       def prompt_user_to_overwrite(file)
-        say "File !txtgrn!#{file}!txtrst! already exists."
-        tty_prompt.expand "  Overwrite?" do |menu|
+        say "File g`#{file}` already exists."
+        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
-          menu.choice key: 's', name: 'skip all'       do @skip_all = true; false end
+          menu.choice key: 'a', name: 'overwrite all'  do
+            @overwrite_all = true
+            true
+          end
+          menu.choice key: 's', name: 'skip all' do
+            @skip_all = true
+            false
+          end
         end
       end
 
@@ -135,16 +140,16 @@ module Rigit::Commands
       end
 
       def verify_target_dir
-        return if Dir.empty?(target_dir) or force
+        return if Dir.empty?(target_dir) || force
 
         dirstring = target_dir == '.' ? 'Current directory' : "Directory '#{target_dir}'"
-        options = { "Abort" => :abort, "Continue here" => :continue, "Continue in a sub directory" => :create }
+        options = { 'Abort' => :abort, 'Continue here' => :continue, 'Continue in a sub directory' => :create }
         response = tty_prompt.select "#{dirstring} is not empty.", options, symbols: { marker: '>' }
-        
+
         case response
         when :abort
-          raise Rigit::Exit, "Goodbye"
-        
+          raise Rigit::Exit, 'Goodbye'
+
         when :create
           create_subdir
           verify_target_dir
@@ -152,12 +157,11 @@ module Rigit::Commands
       end
 
       def create_subdir
-        folder = tty_prompt.ask "Sub directory to create:", default: 'app'
+        folder = tty_prompt.ask 'Sub directory to create:', default: 'app'
         @target_dir = "#{target_dir}/#{folder}"
         Dir.mkdir target_dir unless Dir.exist? target_dir
         say "Creating in #{target_dir}"
       end
-
     end
   end
 end

data/lib/rigit/commands/info.rb

@@ -2,13 +2,12 @@ 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 
+    # Internal class to handle the display of metadata about a rig for the
     # {CommandLine} class.
     class InfoHandler
       include Colsole
@@ -25,13 +24,13 @@ module Rigit::Commands
         info
       end
 
-      private
+    private
 
       def info
         rig.info.each do |key, value|
-          say "!txtgrn!#{key}!txtrst!:"
+          say "g`#{key}`:"
           say word_wrap "  #{value}"
-          say ""
+          say ''
         end
       end
 
@@ -40,10 +39,10 @@ module Rigit::Commands
       end
 
       def verify_presence
-        if !rig.exist?
-          say "Cannot find rig !txtgrn!#{rig_name}"
-          raise Rigit::Exit
-        end
+        return if rig.exist?
+
+        say "Cannot find rig g`#{rig_name}`"
+        raise Rigit::Exit
       end
     end
   end

data/lib/rigit/commands/install.rb

@@ -1,5 +1,5 @@
 module Rigit::Commands
-  # The {Install} module provides the {#install} command for the 
+  # The {Install} module provides the {#install} command for the
   # {CommandLine} module.
   module Install
     # The command line +install+ command.
@@ -24,23 +24,22 @@ module Rigit::Commands
         install
       end
 
-      private
+    private
 
       def install
-        say "Installing !txtgrn!#{repo}"
+        say "Installing g`#{repo}`"
         FileUtils.mkdir_p target_path unless Dir.exist? target_path
         success = Rigit::Git.clone repo, target_path
 
         if success
-          say "Rig installed !txtgrn!successfully!txtrst! in !txtgrn!#{target_path}"
+          say "Rig installed g`successfully` in g`#{target_path}`"
           say "To build a new project with this rig, run this in any empty directory:\n"
-          say "  !txtpur!rig build #{rig_name}\n"
+          say "  m`rig build #{rig_name}`\n"
         else
           # :nocov:
-          say "!txtred!Install failed"
+          say 'r`Install failed`'
           # :nocov:
         end
-
       end
 
       def rig
@@ -52,12 +51,12 @@ module Rigit::Commands
       end
 
       def verify_dirs
-        if rig.exist?
-          say "Rig !txtgrn!#{rig_name}!txtrst! is already installed"
-          say "In order to update it from the source repository, run:\n"
-          say "  !txtpur!rig update #{rig_name}\n"
-          raise Rigit::Exit
-        end
+        return unless rig.exist?
+
+        say "Rig g`#{rig_name}` is already installed"
+        say "In order to update it from the source repository, run:\n"
+        say "  m`rig update #{rig_name}`\n"
+        raise Rigit::Exit
       end
     end
   end

data/lib/rigit/commands/list.rb

@@ -2,13 +2,12 @@ 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 
+    # Internal class to handle listing of available rigs for the
     # {CommandLine} class.
     class ListHandler
       include Colsole
@@ -21,14 +20,14 @@ module Rigit::Commands
       end
 
       def execute
-        prefix = subfolder ? "Subfolders" : "Rigs"
-        say "#{prefix} in !txtgrn!#{basedir}!txtrst!:"
+        prefix = subfolder ? 'Subfolders' : 'Rigs'
+        say "#{prefix} in g`#{basedir}`:"
         dirs.each do |file|
           say "- #{file}"
         end
       end
 
-      private
+    private
 
       def dirs
         files = Dir["#{basedir}/*"]

data/lib/rigit/commands/new_rig.rb

@@ -2,13 +2,12 @@ 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 
+    # Internal class to handle the creation of a new rig template for the
     # {CommandLine} class.
     class NewRigHandler
       include Colsole
@@ -23,20 +22,20 @@ module Rigit::Commands
       def execute
         verify_presence
         Rigit::Rig.create name
-        say "Rig template created in !txtgrn!#{rig.path}"
+        say "Rig template created in g`#{rig.path}`"
       end
 
-      private
+    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
+        return unless rig.exist?
+
+        say "Rig g`#{name}` already exists, choose a different name"
+        raise Rigit::Exit
       end
     end
   end

data/lib/rigit/commands/uninstall.rb

@@ -1,5 +1,5 @@
 module Rigit::Commands
-  # The {Uninstall} module provides the {#uninstall} command for the 
+  # The {Uninstall} module provides the {#uninstall} command for the
   # {CommandLine} module.
   module Uninstall
     # The command line +uninstall+ command.
@@ -23,23 +23,23 @@ module Rigit::Commands
         uninstall
       end
 
-      private
+    private
 
       def uninstall
-        say "This will remove !txtgrn!#{rig_name}!txtrst! and delete\n#{target_path}"
-        continue = tty_prompt.yes? "Continue?", default: false
+        say "This will remove g`#{rig_name}` and delete\n#{target_path}"
+        continue = tty_prompt.yes? 'Continue?', default: false
         uninstall! if continue
       end
 
       def uninstall!
-        say "Uninstalling !txtgrn!#{rig_name}"
+        say "Uninstalling g`#{rig_name}`"
         success = FileUtils.rm_rf target_path
 
         if success
-          say "Rig uninstalled !txtgrn!successfully"
+          say 'Rig uninstalled g`successfully`'
         else
           # :nocov:
-          say "!txtred!Uninstall failed"
+          say 'r`Uninstall failed`'
           # :nocov:
         end
       end
@@ -57,10 +57,10 @@ module Rigit::Commands
       end
 
       def verify_dirs
-        if !rig.exist?
-          say "Rig !txtgrn!#{rig_name}!txtrst! is not installed"
-          raise Rigit::Exit
-        end
+        return if rig.exist?
+
+        say "Rig g`#{rig_name}` is not installed"
+        raise Rigit::Exit
       end
     end
   end

data/lib/rigit/commands/update.rb

@@ -19,16 +19,16 @@ module Rigit::Commands
         update
       end
 
-      private
+    private
 
       def update
-        say "Updating !txtgrn!#{rig_name}"
+        say "Updating g`#{rig_name}`"
         success = Rigit::Git.pull target_path
         if success
-          say "Rig updated !txtgrn!successfully!txtrst!"
+          say 'Rig updated g`successfully`'
         else
           # :nocov:
-          say "!txtred!Update failed"
+          say 'r`Update failed`'
           # :nocov:
         end
       end
@@ -42,10 +42,10 @@ module Rigit::Commands
       end
 
       def verify_dirs
-        if !rig.exist?
-          say "Rig !txtgrn!#{rig_name}!txtrst! is not installed"
-          raise Rigit::Exit
-        end
+        return if rig.exist?
+
+        say "Rig g`#{rig_name}` is not installed"
+        raise Rigit::Exit
       end
     end
   end

data/lib/rigit/config.rb

@@ -3,8 +3,8 @@ require 'yaml'
 
 module Rigit
   # Handles the rig config file.
-  # Usage example: 
-  # 
+  # Usage example:
+  #
   #    Config.load 'path/to.yml'
   #
   class Config
@@ -29,4 +29,4 @@ module Rigit
       settings
     end
   end
-end
+end

data/lib/rigit/errors.rb

@@ -6,9 +6,9 @@ module Rigit
   class TemplateError < StandardError
     attr_reader :file
 
-    def initialize(file, message='')
+    def initialize(file, message = '')
       @file = file
       super message
     end
   end
-end
+end

data/lib/rigit/extensions/file_extension.rb

@@ -10,4 +10,3 @@ class File
     # :nocov:
   end
 end
-

data/lib/rigit/git.rb

@@ -3,25 +3,23 @@ module Rigit
   class Git
     # Clones a git repo.
     def self.clone(repo, target_path)
-      execute %Q[git clone #{repo} "#{target_path}"]
+      execute %[git clone #{repo} "#{target_path}"]
     end
 
     # Pulls a git repo.
     def self.pull(target_path)
       Dir.chdir target_path do
-        execute %Q[git pull]
+        execute %[git pull]
       end
     end
 
-    private
-
     def self.execute(command)
       if ENV['SIMULATE_GIT']
         puts "Simulated Execute: #{command}"
         true
       else
         system command
-        $?&.exitstatus == 0
+        $?&.exitstatus&.zero?
       end
     end
   end

data/lib/rigit/prompt.rb

@@ -3,7 +3,7 @@ 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 
+  # from the rig config file), and asks the user for input one by one, while
   # considering prefilled values.
   class Prompt
     attr_reader :params, :input
@@ -15,16 +15,17 @@ module Rigit
     # 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={})
+    def get_input(prefill = {})
       @input = {}
       params.each do |key, spec|
         next if skip_by_condition? spec
+
         @input[key] = prefill.has_key?(key) ? prefill[key] : ask(spec)
       end
       @input
     end
 
-    private
+  private
 
     def ask(param)
       text = param.prompt
@@ -46,6 +47,7 @@ module Rigit
 
     def skip_by_condition?(spec)
       return unless spec.has_key? :condition
+
       key, value = spec.condition.split '='
       input[key.to_sym] != value
     end
@@ -54,4 +56,4 @@ module Rigit
       @prompt ||= TTY::Prompt.new
     end
   end
-end
+end

data/lib/rigit/rig.rb

@@ -9,7 +9,7 @@ module Rigit
       ENV['RIG_HOME'] ||= File.expand_path('.rigs', Dir.home)
     end
 
-    # Sets the +RIG_HOME+ environment variable, and the new root path for 
+    # Sets the +RIG_HOME+ environment variable, and the new root path for
     # rigs.
     def self.home=(path)
       ENV['RIG_HOME'] = path
@@ -19,26 +19,26 @@ module Rigit
     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 
+    # 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, 
+    def scaffold(arguments: {}, target_dir: '.', &block)
+      scaffold_dir dir: "#{path}/base", arguments: arguments,
         target_dir: target_dir, &block
 
-      arguments.each do |key, value| 
+      arguments.each do |key, value|
         additive_dir = "#{path}/#{key}=#{value}"
         if Dir.exist? additive_dir
-          scaffold_dir dir: additive_dir, arguments: arguments, 
+          scaffold_dir dir: additive_dir, arguments: arguments,
             target_dir: target_dir, &block
         end
       end
@@ -54,7 +54,7 @@ module Rigit
       Dir.exist? path
     end
 
-    # Returns true if the rig has a +config.yml+ file. 
+    # Returns true if the rig has a +config.yml+ file.
     def has_config?
       File.exist? config_file
     end
@@ -72,13 +72,13 @@ module Rigit
     # Returns metadata about the rig, including all of its config values.
     def info
       {
-        name: name,
-        path: path,
-        config: (has_config? ? File.read(config_file) : '<empty>')
+        name:   name,
+        path:   path,
+        config: (has_config? ? File.read(config_file) : '<empty>'),
       }
     end
 
-    private
+  private
 
     def scaffold_dir(dir:, arguments:, target_dir:)
       files = Dir.glob("#{dir}/**/*", File::FNM_DOTMATCH) - %w[. ..]
@@ -86,7 +86,8 @@ module Rigit
 
       files.each do |file|
         target_file = get_target_filename file, arguments, target_dir, dir
-        next if block_given? and !yield target_file
+        next if block_given? && !yield(target_file)
+
         content = get_file_content file, arguments
         File.deep_write target_file, content
       end
@@ -114,6 +115,7 @@ module Rigit
 
     def binary?(file)
       return false unless config.binaries
+
       config.binaries.each do |pattern|
         return true if File.fnmatch pattern, file
       end

data/lib/rigit/version.rb

@@ -1,3 +1,3 @@
 module Rigit
-  VERSION = "0.2.1"
-end
+  VERSION = '0.3.0'
+end

data/lib/rigit.rb

@@ -1,4 +1,4 @@
-require 'rigit/extensions/file_extension.rb'
+require 'rigit/extensions/file_extension'
 
 require 'rigit/config'
 require 'rigit/errors'

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: rigit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-08 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: super_docopt
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: configatron
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +45,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.5'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: super_docopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: colsole
+  name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.19'
 description: Build project templates with ease
 email: db@dannyben.com
 executables:
@@ -96,7 +102,8 @@ files:
 homepage: https://dannyben.github.io/rigit/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -105,14 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Zero-coding project scaffolding