begin_cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e81ba548666c85ad86e52b27b0c559a683d1a2e9
+  data.tar.gz: 3b7d6cc55d5e16ac49d99e9b0025d54538040202
+SHA512:
+  metadata.gz: 14951d1b81a107188e8f21bffc6b0f2733e815bd51da3b4332c67b76936c3ea687fec84f3e25c7e9ce5c03fd2629ae2056bf2fad64a9ed35233df0bf8ceb270b
+  data.tar.gz: 4b0d650e1613e63af6815ba55d850b2f6069f7dd456c4c9a68d2028e7fd7962e3c7afefb737c30411ad034fddfc2888c76a95135bcd256b03e369a324f27979d

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Begin 1.0.0
+
+* Initial version of Begin
+
+* Support for both Git based and File-System based templates
+
+* Support for Mustache tags in template file names, directory names, and file content
+
+* Read the docs at: [https://jbrd.github.io/begin](https://jbrd.github.io/begin)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jbrd.git@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 James Bird
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,145 @@
+# begin
+
+`begin` is a terminal command for running logic-less project templates. Templates are just [git](https://git-scm.com)
+repositories whose files and directories are copied to the working directory when run. Directory names, file names, 
+and file content can contain [Mustache](https://mustache.github.io/mustache.5.html) tags - the values of which are
+prompted for in the terminal and substituted when the template is run.
+
+<div align="center">
+  <img alt="Begin Terminal Example" src="docs/assets/terminal.png" />
+</div>
+
+
+## Installation
+
+To install on your system, obtain the Ruby gem with:
+
+```bash
+$ gem install begin_cli
+```
+
+Read the [Installation Guide](https://jbrd.github.io/begin/install.html) for more in-depth examples
+for various operating systems.
+
+
+## Overview
+
+### Installing A Template
+
+* Install a template with the ```begin install``` command, e.g:
+
+  ```bash
+  $ begin install path/to/template.git
+  ```
+
+* Once you have installed a template, you may run it...
+
+
+### Running A Template
+
+* Run a template with the ```begin new``` command, e.g:
+
+  ```bash
+  $ begin new template
+  ```
+
+
+### Template Structure
+
+* A template is just a [Git](https://git-scm.com) repository
+
+* A template can therefore contain any number of files and directories, and can be easily shared with others
+
+* A template name can optionally start with `begin-`. This prefix is ignored and stripped by the command automatically, e.g:
+
+  ```bash
+  $ begin install path/to/begin-latex-document.git
+  $ begin new latex-document
+  ```
+
+* An example template can be found at (https://github.com/jbrd/begin-latex-document)[https://github.com/jbrd/begin-latex-document], e.g:
+
+  ```bash
+  $ begin install https://github.com/jbrd/begin-latex-document.git
+  $ begin new latex-document
+  ```
+
+
+### Template Tags
+
+* File names, directory names, and file content can contain [Mustache](https://mustache.github.io/mustache.5.html) tags
+
+
+* Create a ```.begin.yml``` in your template repository to describe expected tags:
+
+  ```yaml
+  tags: !!omap
+      title:
+          label: 'Title'
+      author:
+          label: 'Author'
+      sections:
+          label: 'Sections'
+          array: true
+  ```
+
+
+* The user will be prompted for expected tags upon running a template:
+
+  ```
+  $ begin new latex-document
+  Title: My Amazing New Document
+  Author: John Smith
+  Sections (CTRL+D to stop): Introduction
+  Sections (CTRL+D to stop): Background
+  Sections (CTRL+D to stop): ^D
+  Running template 'latex-document'...
+  Template 'latex-document' successfully run
+  ```
+
+### Terminal Commands
+
+* Run a template with ```begin new```
+
+* List installed templates with ```begin list```
+
+* Install a template with ```begin install```
+
+* Uninstall a template with ```begin uninstall```
+
+* Update templates with ```begin update```
+
+* Get help with ```begin help```
+
+* Print the command version with ```begin version```
+
+
+## Example Templates
+
+* An example template can be found at: [https://github.com/jbrd/begin-latex-document.git](https://github.com/jbrd/begin-latex-document.git)
+
+
+## Development
+
+* Ensure [Bundler](http://bundler.io/) is installed on your system
+* After checking out the repo, run ```bundle install --path vendor/bundle``` to install dependencies
+* Run ```bundle exec begin``` to use the gem in this directory, ignoring other installed copies of this gem
+* Run ```bundle exec rake``` to run test specs and ensure the code conforms to style guidelines
+* To package this gem from source, run ```bundle exec rake install```
+* To release a new version, update the version number in `version.rb`, and then run ```bundle exec rake release```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jbrd/begin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## Contributors
+
+* James Bird (jbrd)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/begin_cli.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'begin/version'
+
+GEM_NAME = 'begin_cli'.freeze
+
+SUMMARY = \
+  'A terminal command for running logic-less project templates.'.freeze
+
+DESCRIPTION = \
+  'A terminal command for running logic-less project templates. ' \
+  'Templates are just git repositories whose files and directories ' \
+  'are copied to the working directory when run. Directory names, ' \
+  'file names, and file content can contain Mustache tags - the ' \
+  'values of which are prompted for in the terminal and substituted ' \
+  'when the template is run.'.freeze
+
+Gem::Specification.new do |spec|
+  spec.name          = GEM_NAME
+  spec.version       = Begin::VERSION
+  spec.authors       = ['James Bird']
+  spec.email         = ['jbrd.git@outlook.com']
+
+  spec.summary       = SUMMARY
+  spec.description   = DESCRIPTION
+
+  spec.homepage      = 'https://jbrd.github.io/begin'
+  spec.license       = 'MIT'
+
+  spec.files = %w(begin_cli.gemspec) + Dir["*.md", "exe/*", "lib/**/*.rb"]
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+
+  spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'git', '~> 1.3'
+  spec.add_dependency 'mustache', '~> 1.0'
+  spec.add_dependency 'thor', '~> 0.20'
+end

data/exe/begin

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'begin'
+require 'begin/output'
+
+begin
+  Begin::CLI.start(ARGV)
+rescue Interrupt
+  Begin::Output.error 'Process Interrupted'
+  exit 1
+rescue StandardError => e
+  Begin::Output.error e.message
+  exit 1
+end

data/lib/begin.rb

@@ -0,0 +1,2 @@
+require 'begin/cli'
+require 'begin/version'

data/lib/begin/cli.rb

@@ -0,0 +1,73 @@
+require 'begin/input'
+require 'begin/output'
+require 'begin/repository'
+require 'begin/version'
+require 'thor'
+require 'yaml'
+
+module Begin
+  # The CLI interface for the application.
+  class CLI < Thor
+    desc 'new TEMPLATE', 'Begin a new project by running the named TEMPLATE'
+    option :yaml, desc: 'Do not prompt user for tag values. ' \
+                        'Instead, take them from given YAML file.'
+    def new(template)
+      template_impl = repository.template template
+      if options[:yaml]
+        context = YAML.load_file(options[:yaml])
+      else
+        context = Input.prompt_user_for_tag_values(template_impl.config.tags)
+      end
+      Output.action "Running template '#{template}'"
+      template_impl.run Dir.getwd, context
+      Output.success "Template '#{template}' successfully run"
+    end
+
+    desc 'list', 'List installed templates'
+    def list
+      repository.each { |x| Output.info(x) }
+    end
+
+    desc 'install PATH', 'Installs a template given its PATH'
+    def install(path)
+      repo = repository
+      template_name = repo.template_name path
+      Output.action "Installing template '#{template_name}' from '#{path}'"
+      repo.install path, template_name
+      Output.success "Template '#{template_name}' successfully installed"
+    end
+
+    desc 'uninstall TEMPLATE', 'Uninstalls the named TEMPLATE'
+    def uninstall(template)
+      template_impl = repository.template template
+      Output.action "Uninstalling template #{template}"
+      template_impl.uninstall
+      Output.success "Template '#{template}' successfully uninstalled"
+    end
+
+    desc 'update [TEMPLATE]', 'Updates all templates or one specific TEMPLATE'
+    def update(template = nil)
+      if template
+        template_impl = repository.template template
+        Output.action "Updating template #{template}"
+        template_impl.update
+      else
+        repository.each do |x|
+          Output.action "Updating template #{x}"
+          repository.template(x).update
+        end
+      end
+    end
+
+    desc 'version', 'Prints the version of this command'
+    def version
+      Output.info VERSION
+    end
+
+    no_commands do
+      def repository
+        Repository.new
+      end
+    end
+  end
+end

data/lib/begin/config.rb

@@ -0,0 +1,99 @@
+require 'yaml'
+
+module Begin
+  # The root-level template configuration structure. A class representation
+  # of the template config file (.begin.yml)
+  class Config
+    @tags = []
+
+    attr_reader :tags
+
+    def initialize(tags)
+      @tags = tags
+    end
+
+    def self.from_file(path)
+      if path.exists?
+        config = YAML.load_file path
+        tags = HashTag.from_config_hash(config)
+        Config.new tags
+      else
+        {}
+      end
+    end
+  end
+
+  # Represents an expected mustache tag, as defined in the template config.
+  # Every type of tag has a key name (as inserted into the mustache context),
+  # and a human-readable label (as presented to the user).
+  class Tag
+    @key = ''
+    @label = ''
+    @array = false
+
+    attr_reader :key
+    attr_reader :label
+    attr_reader :array
+
+    def initialize(key, label, array)
+      @key = key
+      @label = label
+      @array = array
+    end
+
+    def self.from_config(key, value)
+      return HashTag.from_config(key, value) if value.include? 'tags'
+      ValueTag.from_config(key, value)
+    end
+  end
+
+  # Represents a tag with a single value. Value tags can have a default value
+  # assigned in the config. If the user chooses not to enter a value, the
+  # default value is substituted instead.
+  class ValueTag < Tag
+    @default = ''
+
+    attr_reader :default
+
+    def initialize(key, label, array, default)
+      super key, label, array
+      @default = default
+    end
+
+    def self.from_config(key, value)
+      array = value.include?('array') ? value['array'] : false
+      label = value.include?('label') ? value['label'] : key
+      default = value.include?('default') ? value['default'] : ''
+      ValueTag.new key, label, array, default
+    end
+  end
+
+  # Represents a nested object hash tag. On encountering a hash tag, the user
+  # is prompted to enter a value for each member of the hash.
+  class HashTag < Tag
+    @children = []
+
+    attr_reader :children
+
+    def initialize(key, label, array, children)
+      super key, label, array
+      @children = children
+    end
+
+    def self.from_config_hash(config)
+      return [] unless config.include?('tags') && config['tags'].is_a?(Hash)
+      config['tags'].each.map do |key, value|
+        raise "Invalid template. Expected value of '#{key}' to be a Hash" \
+          unless value.is_a? Hash
+        Tag.from_config key, value
+      end
+    end
+
+    def self.from_config(key, value)
+      array = value.include?('array') ? value['array'] : false
+      label = value.include?('label') ? value['label'] : key
+      children = value.include?('tags') ? from_config_hash(value) : []
+      HashTag.new key, label, array, children
+    end
+  end
+end

data/lib/begin/input.rb

@@ -0,0 +1,61 @@
+module Begin
+  # All console input is routed through this module
+  module Input
+    module_function
+
+    def prompt(msg)
+      STDOUT.write msg
+      begin
+        value = STDIN.gets
+        raise EOFError if value.nil?
+        return value.chomp
+      rescue StandardError, Interrupt
+        Output.newline
+        raise
+      end
+    end
+
+    def prompt_user_for_tag(tag, level = 0, in_array = false)
+      indent = '  ' * level
+      array_msg = in_array ? " (#{eof_shortcut} to stop)" : ''
+      case tag
+      when HashTag
+        Output.info "#{indent}#{tag.label}#{array_msg}:"
+        prompt_user_for_tag_values tag.children, level + 1
+      when ValueTag
+        prompt "#{indent}#{tag.label}#{array_msg}: "
+      end
+    end
+
+    def prompt_user_for_array_tag(tag, level = 0)
+      result = []
+      loop do
+        begin
+          value = prompt_user_for_tag tag, level, true
+          result.push value
+        rescue EOFError
+          break
+        end
+      end
+      result
+    end
+
+    def prompt_user_for_tag_values(tags, level = 0)
+      context = {}
+      tags.each do |x|
+        context[x.key] = prompt_user_for_array_tag(x, level) if x.array
+        context[x.key] = prompt_user_for_tag(x, level) unless x.array
+      end
+      context
+    end
+
+    # Returns the keyboard accelerator shortcut for the EOF signal,
+    # which is dependant on the host terminal
+    def eof_shortcut
+      if ENV.key? 'ComSpec'
+        return 'CTRL+Z' if ENV['ComSpec'].upcase.end_with? '\CMD.EXE'
+      end
+      'CTRL+D'
+    end
+  end
+end

data/lib/begin/output.rb

@@ -0,0 +1,33 @@
+require 'colorize'
+
+module Begin
+  # All console output is routed through this module ensuring
+  # it is formatted consistently
+  module Output
+    module_function
+
+    def error(value)
+      STDERR.puts "ERROR: #{value}".colorize :red
+    end
+
+    def warning(value)
+      STDOUT.puts "WARNING: #{value}".colorize :yellow
+    end
+
+    def info(value)
+      STDOUT.puts value
+    end
+
+    def action(value)
+      STDOUT.puts "#{value}..."
+    end
+
+    def success(value)
+      STDOUT.puts value.colorize :green
+    end
+
+    def newline
+      STDOUT.puts ''
+    end
+  end
+end

data/lib/begin/path.rb

@@ -0,0 +1,80 @@
+module Begin
+  # The canonical file path representation used throughout the application.
+  # Paths are immediately expanded into absolute file paths on construction
+  class Path
+    def initialize(path, parent_dir, help)
+      @path = File.expand_path path, parent_dir
+      @help = help
+    end
+
+    def eql?(other)
+      @path.eql?(other.to_str)
+    end
+
+    def hash
+      @path.hash
+    end
+
+    def to_s
+      @path
+    end
+
+    def to_str
+      @path
+    end
+
+    def ensure_exists
+      return if File.exist? @path
+      raise IOError, "#{@help} '#{@path}' does not exist"
+    end
+
+    def ensure_symlink_exists
+      ensure_exists
+      return if File.symlink? @path
+      raise IOError, "#{@help} '#{@path}' is not a symbolic link"
+    end
+
+    def ensure_dir_exists
+      ensure_exists
+      return if directory?
+      raise IOError, "#{@help} '#{@path}' is not a directory"
+    end
+
+    def dir_contents
+      escaped_path = @path.gsub(/[\\\{\}\[\]\*\?\.]/) { |x| '\\' + x }
+      Dir.glob(File.join([escaped_path, '*']))
+    end
+
+    def make_dir
+      Dir.mkdir @path unless File.exist? @path
+      ensure_dir_exists
+    end
+
+    def make_parent_dirs
+      parent = File.dirname @path
+      FileUtils.mkdir_p parent
+    end
+
+    def copy_to(destination)
+      ensure_exists
+      destination.ensure_dir_exists
+      FileUtils.cp @path, destination
+    end
+
+    def basename
+      File.basename @path
+    end
+
+    def directory?
+      File.directory? @path
+    end
+
+    def exists?
+      File.exist? @path
+    end
+
+    def contains?(path)
+      path.to_str.start_with? @path
+    end
+  end
+end

data/lib/begin/repository.rb

@@ -0,0 +1,68 @@
+require 'begin/output'
+require 'begin/path'
+require 'begin/template'
+require 'git'
+require 'uri'
+
+module Begin
+  # Provides centralised access to the local repository of templates
+  # on the machine
+  class Repository
+    def initialize(name = '.begin', parent_dir = '~')
+      @parent_dir = Path.new(parent_dir, '.', 'Repository Parent')
+      @parent_dir.ensure_dir_exists
+      @repo_dir = Path.new(name, @parent_dir, 'Repository directory')
+      @template_dir = Path.new('templates', @repo_dir, 'Templates directory')
+    end
+
+    def install(source_uri, name)
+      path = install_prerequisites(name)
+      begin
+        return GitTemplate.install source_uri, path
+      rescue
+        unless source_uri.include? '://'
+          return SymlinkTemplate.install source_uri, path
+        end
+        raise
+      end
+    end
+
+    def install_prerequisites(name)
+      @repo_dir.make_dir
+      @template_dir.make_dir
+      path = template_path name
+      raise "A template is already installed at: #{path}" if path.exists?
+      Output.info "Installing to '#{path}'"
+      path
+    end
+
+    def each
+      templates = @template_dir.dir_contents
+      templates.each { |x| yield template_name x }
+    end
+
+    def template(name)
+      path = template_path name
+      template_from_path path
+    end
+
+    def template_name(uri)
+      uri = URI(uri)
+      path_bits = uri.path.split '/'
+      name = path_bits.last
+      name.slice! 'begin-'
+      name.slice! 'begin_'
+      name.chomp! '.git'
+      name
+    end
+
+    def template_path(template_name)
+      Path.new template_name, @template_dir, 'Template directory'
+    end
+
+    def template_from_path(path)
+      return SymlinkTemplate.new(path) if File.symlink? path
+      GitTemplate.new path
+    end
+  end
+end

data/lib/begin/template.rb

@@ -0,0 +1,215 @@
+require 'begin/config'
+require 'begin/output'
+require 'begin/path'
+require 'fileutils'
+require 'git'
+require 'mustache'
+require 'uri'
+
+module Begin
+  # Represents an installed template on the user's machine.
+  class Template
+    CONFIG_NAME = '.begin.yml'.freeze
+
+    def initialize(path)
+      @path = path
+      @path.ensure_dir_exists
+    end
+
+    def uninstall
+      # Must be implemented in base class
+      raise NotImplementedError
+    end
+
+    def update
+      # Must be implemented in base class
+      raise NotImplementedError
+    end
+
+    def config_path
+      Path.new CONFIG_NAME, @path, 'Config'
+    end
+
+    def config
+      Config.from_file config_path
+    end
+
+    def run(target_dir, context)
+      target_dir = Path.new target_dir, '.', 'Directory'
+      target_dir.ensure_dir_exists
+      paths = process_path_names @path, target_dir, context
+      process_files paths, context
+    end
+
+    def ensure_no_back_references(source_path, expanded_path, target_dir)
+      return if target_dir.contains? expanded_path
+      err = 'Backward-reference detected in expanded ' \
+            "template path. Details to follow.\n"
+      err += "Source Path:     #{source_path}\n"
+      err += "Expanded Path:   #{expanded_path}\n"
+      err += "Expected Parent: #{target_dir}\n"
+      raise err
+    end
+
+    def ensure_no_conflicts(paths, source_path, target_path)
+      return unless paths.key? target_path
+      err = "File path collision detected. Details to follow.\n"
+      err += "(1) Source File: #{source_path}\n"
+      err += "(1) ..Writes To: #{target_path}\n"
+      err += "(2) Source File: #{paths[target_path]}\n"
+      err += "(2) ..Writes To: #{target_path}\n"
+      raise err
+    end
+
+    def ensure_name_not_empty(source_path, expanded_name)
+      return unless expanded_name.empty?
+      err = "Mustache evaluation resulted in an empty file name...\n"
+      err += "... whilst evaluating: #{source_path}"
+      raise err
+    end
+
+    def process_path_name(source_path, target_dir, context)
+      expanded_name = Mustache.render source_path.basename, context
+      ensure_name_not_empty source_path, expanded_name
+      expanded_path = Path.new expanded_name, target_dir, 'Target'
+      ensure_no_back_references source_path, expanded_path, target_dir
+      expanded_path
+    end
+
+    def process_path_names_in_dir(source, target, paths, working_set, context)
+      source.dir_contents.each do |entry|
+        source_path = Path.new entry, '.', 'Source'
+        target_path = process_path_name source_path, target, context
+        ensure_no_conflicts paths, source_path, target_path
+        paths[target_path] = source_path
+        working_set.push [source_path, target_path] if source_path.directory?
+      end
+    end
+
+    def process_path_names(source_dir, target_dir, context)
+      paths = {}
+      working_set = [[source_dir, target_dir]]
+      until working_set.empty?
+        source, target = working_set.pop
+        process_path_names_in_dir source, target, paths, working_set, context
+      end
+      paths
+    end
+
+    def process_file(source_path, target_path, context)
+      contents = File.read source_path
+      File.write target_path, Mustache.render(contents, context)
+    end
+
+    def process_files(paths, context)
+      paths.each do |target, source|
+        target.make_parent_dirs
+        if source.directory?
+          target.make_dir
+        else
+          process_file source, target, context
+        end
+      end
+    end
+  end
+
+  # Encapsulates the logic for templates that are installed as symlinks
+  # on the user's machine.
+  class SymlinkTemplate < Template
+    def initialize(path)
+      super path
+      @path.ensure_symlink_exists
+    end
+
+    def self.install(source_uri, path)
+      source_path = Path.new source_uri, '.', 'Source path'
+      source_path.ensure_dir_exists
+      begin
+        File.symlink source_path, path
+        Output.success "Created symbolic link to '#{source_path}'"
+      rescue NotImplementedError
+        raise NotImplementedError, 'TODO: Copy tree when symlinks not supported'
+      end
+      SymlinkTemplate.new path
+    end
+
+    def update
+      # Do nothing. Symlink templates are always up-to-date.
+    end
+
+    def uninstall
+      File.unlink @path
+    end
+  end
+
+  # Encapsulates the logic for templates that are installed as cloned
+  # git repositories on the user's machine.
+  class GitTemplate < Template
+    def initialize(path)
+      super path
+      @repository = Git.open(path.to_s)
+    end
+
+    def self.format_git_error_message(e)
+      partition = e.message.partition('2>&1:')
+      partition[2]
+    end
+
+    def self.install(source_uri, path)
+      Git.clone(source_uri, path.to_s)
+      Output.success 'Template source was successfully git cloned'
+      GitTemplate.new path
+    rescue Git::GitExecuteError => e
+      raise format_git_error_message(e)
+    end
+
+    def uninstall
+      FileUtils.rm_rf @path
+    end
+
+    def check_repository
+      @repository.revparse('HEAD')
+      if @repository.current_branch.include? 'detached'
+        raise "HEAD is detached in local repository. Please fix: #{@path}"
+      end
+    rescue Git::GitExecuteError => e
+      error = "HEAD is not valid in local repository. Please fix: #{@path}\n"
+      error += format_git_error_message(e)
+      raise error
+    end
+
+    def check_tracking_branch
+      @repository.revparse('@{u}')
+    rescue
+      raise "Local branch '#{@repository.current_branch}' does not track " \
+            "an upstream branch in local repository: #{@path}"
+    end
+
+    def check_untracked_changes
+      message = 'Local repository contains untracked changes. ' \
+                "Please fix: #{@path}"
+      raise message unless @repository.status.untracked.empty?
+    end
+
+    def check_pending_changes
+      not_added = @repository.status.added.empty?
+      not_deleted = @repository.status.deleted.empty?
+      not_changed = @repository.status.changed.empty?
+      message = 'Local repository contains modified / staged files. ' \
+                "Please fix: #{@path}"
+      raise message unless not_added && not_deleted && not_changed
+    end
+
+    def update
+      check_repository
+      check_tracking_branch
+      check_untracked_changes
+      check_pending_changes
+      begin
+        @repository.pull
+      rescue Git::GitExecuteError => e
+        raise format_git_error_message(e)
+      end
+    end
+  end
+end

data/lib/begin/version.rb

@@ -0,0 +1,3 @@
+module Begin
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: begin_cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- James Bird
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: A terminal command for running logic-less project templates. Templates
+  are just git repositories whose files and directories are copied to the working
+  directory when run. Directory names, file names, and file content can contain Mustache
+  tags - the values of which are prompted for in the terminal and substituted when
+  the template is run.
+email:
+- jbrd.git@outlook.com
+executables:
+- begin
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.md
+- README.md
+- begin_cli.gemspec
+- exe/begin
+- lib/begin.rb
+- lib/begin/cli.rb
+- lib/begin/config.rb
+- lib/begin/input.rb
+- lib/begin/output.rb
+- lib/begin/path.rb
+- lib/begin/repository.rb
+- lib/begin/template.rb
+- lib/begin/version.rb
+homepage: https://jbrd.github.io/begin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A terminal command for running logic-less project templates.
+test_files: []