provision-vagrant 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f33f4fffa23760ab39bfab3226f5a1aacfcc4dee67106ca6986b7693a6c51920
+  data.tar.gz: c860b10affe58159b45918d42c4e714389319c00151e5df470138bdcf2c88b0b
+SHA512:
+  metadata.gz: ef56df7f3a324e8dd2b9c456c6940776c9f68cd53b303266048c75d3d2b3b100b5b1c0170d55a9411020f6b0f54aae130667e67ead08ac38992f277ed9a97f00
+  data.tar.gz: d5e53c32ca810d69cb6c4a0d46013600819496d7d14fc0f5ac0e292a91e462da617e2c216d9f63d50c10f3257ce5aa9d7f3260fb8f6ac633d56fde7d19c038c1

data/bin/provision-vagrant

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/provision_vagrant'
+
+# Require all Ruby files in 'lib/'
+Dir[File.join(__dir__, '..', 'lib', '*.rb')].each do |file|
+  require file unless file.end_with?('porvision-vagrant')
+end
+
+def main
+  include ProvisionVagrant
+
+  options_klass_obj = ProvisionVagrant::Options.new
+  options = options_klass_obj.parse_options
+  options_klass_obj.help 'New project name must be specified. Ex: provision-vagrant foo-app' if ARGV.empty?
+
+  project_name = ARGV[0]
+  options[:project_name] = project_name
+
+  puts "\n\n options in main bin app: #{options.inspect}\n\n"
+  generator = Generator.new(options)
+  generator.generate
+end
+
+main

data/lib/generator.rb

@@ -0,0 +1,107 @@
+require 'options'
+require 'yaml'
+
+module ProvisionVagrant
+
+  class Generator
+
+    def initialize(opts = {})
+      @opts = opts
+      @project_name = opts[:project_name]
+      @initializer = PvInitializer.new(opts)
+      @config_opts = read_config_opts(opts[:config])
+    end
+
+    def generate
+      puts "\nNew box name: #{project_name}"
+      create_new_project_dir
+
+      if !File.exist?(dev_box_dir_path)
+        ProvisionVagrant.help("Error: there was a problem creating target project directory: #{dev_box_dir_path}")
+      end
+
+      copy_vagrantfile
+      puts "\nNext, cd into your new project directory: #{dev_box_dir_path}"
+      puts "\nAnd start/provision your new vagrant box:\n\n  vagrant up\n"
+      puts "\nOnce your vagrant vm is running, ssh in as usual:\n\n  vagrant ssh\n"
+      puts "\nThe first time you login, run the post hooks installation script:\n\n  ./#{POST_HOOK_FILE_NAME}\n"
+      puts "\nSuccess! Exiting.\n"
+    end
+
+    def delete
+      [default_config_path,
+       default_vagrantilfe_path,
+       default_post_hook_path].each do |file_name|
+        if File.exist?(file_name)
+          puts "Removing: #{file_name}"
+          FileUtils.rm_f(file_name)
+        end
+      end
+    end
+
+    def project_path
+      @_project_path ||= File.join(initializer.user_directory, project_name)
+    end
+
+    def dev_box_dir_path
+      @_dev_box_dir_path ||= File.join(initializer.user_directory, project_name, "dev-box/")
+    end
+
+    def create_new_project_dir
+      puts "Creating #{project_name} directory: #{dev_box_dir_path}"
+      FileUtils.mkdir_p(dev_box_dir_path)
+    end
+
+    def copy_vagrantfile
+      vars = config_opts.merge({ project_name: project_name })
+      interpolator = Interpolator.new( { vars: vars, input: vagrantfile_string })
+      interpolated = interpolator.interpolate
+
+      ProvisionVagrant.write_string_to_File(interpolated, target_vagrantfile_path)
+      if File.exist?(target_vagrantfile_path)
+        puts "Copied #{vagrantfile_path} (and inerpolated its vars) to: #{target_vagrantfile_path}"
+      else
+        ProvisionVagrant.help("Error: there was a problem copying over your Vagrantilfe.template (dfeault) from #{vagrantfile_path} to #{target_vagrantfile_path}")
+      end
+    end
+
+    def default_config_path
+      @_default_config_path ||= File.join(initializer.user_directory, PROVISION_VAGRANT_CONFIG_FILE_NAME)
+    end
+
+    def default_vagrantilfe_path
+      @_default_vagrantfile_path ||= File.join(initializer.user_directory, VAGRANTFILE_NAME)
+    end
+
+    def default_post_hook_path
+      @_default_post_hook_path ||= File.join(initializer.user_directory, POST_HOOK_FILE_NAME)
+    end
+
+    def vagrantfile_path
+     @_vagrantfile_path ||= (opts[:template] || default_vagrantilfe_path)
+    end
+
+    def target_vagrantfile_path
+      @_target_vagrantfile_path ||= File.join(dev_box_dir_path, VAGRANTFILE_TARGET_NAME)
+    end
+
+    def vagrantfile_string
+      File.read(vagrantfile_path)
+    end
+
+    private
+
+    attr_accessor :opts, :config_opts, :initializer, :project_name
+
+    def read_config_opts(config_path = nil)
+      config_path ||= default_config_path
+      return {} unless File.exist?(config_path)
+
+      yaml_hash = YAML.load_file(config_path)
+      return {} unless yaml_hash && yaml_hash["configuration"]
+
+      yaml_hash["configuration"]
+    end
+  end
+
+end

data/lib/interpolator.rb

@@ -0,0 +1,25 @@
+module ProvisionVagrant
+
+  class Interpolator
+
+    DEFAULT_VAGRANTFILE_NAME = "Vagrantfile.template"
+    DEFAULT_POST_HOOK_FILE_NAME = "provision-vagrant.post-hook.sh"
+
+    def initialize(opts = {})
+      @vars = opts[:vars]
+      @input = opts[:input]
+    end
+
+    # Loops through a Hash (@vars) and replaces any of its keys found in
+    # the @input string with the corresponding hash values
+    def interpolate
+      @vars.each do |k, v|
+        var_wrapped = "{{#{k.to_s}}}"
+        @input.gsub!(var_wrapped, v.to_s)
+      end
+
+      @input
+    end
+  end
+
+end

data/lib/options.rb

@@ -0,0 +1,113 @@
+
+require 'optparse'
+require 'paint'
+
+module ProvisionVagrant
+
+  class Options
+
+    def initialize
+    end
+
+    def parse_options
+      options = { verbose: false }
+      OptionParser.new do |parser|
+        @parser = parser
+
+        parser.on("-c", "--config", "Specify the yml config file to use") do |c|
+          options[:config] = c
+        end
+
+        parser.on("-d", "--delete", "Delete files copied over from init command") do |d|
+          options[:delete] = true
+        end
+
+        parser.on("-f", "--force", "Force initialization even if target files already exist") do |f|
+          options[:force] = true
+        end
+
+        parser.on("-t", "--template", "Specify the path the to the Vagrantfile template") do |t|
+          options[:template] = t
+        end
+
+        parser.on("-v", "--version", "Shows the version number") do |v|
+          options[:version] = true
+        end
+
+        parser.on("-h", "--help", "Show this help message") do |h|
+          options[:help] = true
+        end
+
+        parser.on("-i", "--init", "Initialize provision-vagrant with files it needs to operate") do |i|
+          options[:init] = true
+        end
+      end.parse!
+
+      if options[:version]
+        help(ProvisionVagrant.version)
+      end
+
+      if options[:help]
+        help
+      end
+
+      if options[:delete]
+        Generator.new.delete
+        exit(true)
+      end
+
+      if options[:config] && !File.exist?(options[:config])
+        help "Error: Invalid config file specified (not found): #{CONFIG}"
+      end
+
+      if options[:temlpate] && !File.exist(options[:template])
+        help "Error: Invalid template file specified (not found): #{TEMPLATE}"
+      end
+
+      if options[:init]
+        initiliazer = PvInitializer.new(options)
+        initiliazer.init
+        exit(true)
+      end
+
+      options
+    end
+
+    def help(msg = nil)
+      if msg
+        puts(Paint["\n#{msg}\n", :yellow])
+        exit(false)
+      end
+
+      msg = <<~END_HELP
+        provision-vagrant: Generates and provisions a new vagrant vm box using template files
+
+        Syntax: provision-vagrant NEW_BOX_NAME
+
+        Options:
+          -c Specify a path to the config yml file to use (default: ~/provision-vagrant.yml)
+          -d Delete files copied over from init command
+          -h Show this help message
+          -t Specify a path to the Vagrantfile template to use (default: ~/Vagrantfile.template)
+          -v Show version number
+
+        Example:
+
+          provision-vagrant foo-bar-app
+
+        This will do the following:
+
+          - Create a new directory "foo-bar-app" under your home directory
+          - Create a "dev-box" directory within that directory (~/foo-bar-app/dev-box/)
+          - Copy over ~/Vagrantfile.template and replace the {{vars}} with project/config vars
+
+        See:
+          https://github.com/sbraford/provision-vagrant
+      END_HELP
+
+      puts(Paint[msg, :magenta])
+      exit(true)
+    end
+
+  end
+end

data/lib/provision_vagrant.rb

@@ -0,0 +1,21 @@
+module ProvisionVagrant
+
+  VAGRANTFILE_NAME = "Vagrantfile.template"
+  POST_HOOK_FILE_NAME = "provision-vagrant.post-hook.sh"
+  PROVISION_VAGRANT_CONFIG_FILE_NAME = "provision-vagrant.yml"
+  VAGRANTFILE_TARGET_NAME = "Vagrantfile"
+
+  def self.version
+    "1.0.1"
+  end
+
+  def self.write_string_to_File(string, file_path)
+    File.open(file_path, "w") {|file| file.puts string }
+  end
+
+  def self.help(msg)
+    puts(Paint["\n#{msg}\n", :yellow])
+    exit(false)
+  end
+
+end

data/lib/pv_initializer.rb

@@ -0,0 +1,160 @@
+require 'fileutils'
+
+module ProvisionVagrant
+
+  class PvInitializer
+
+    def initialize(opts = {})
+      @opts = opts
+      @opts.merge!(read_default_config_opts)
+    end
+
+    def init
+      puts "\nUsing home directory: #{user_directory}"
+
+      if !opts[:force] && (File.exist?(target_vagrantfile_path) || File.exist?(target_post_hook_path))
+        help("Aborting. One of the target output files already exists: #{target_file_list}")
+        exit(false)
+      end
+
+      copy_vagrantfile_template
+      copy_interpolated_post_hook
+      copy_provision_vagrant_config
+
+      if File.exist?(target_vagrantfile_path) &&
+           File.exist?(target_post_hook_path) &&
+           File.exist?(target_provision_vagrant_config_path)
+        puts "\nSuccess! You should now be ready to use provision-vagrant. Usage:\n\n"
+        puts "  provision-vagrant new-box-name\n\n"
+        exit(1)
+      else
+        msg = "Error: There was a probelm initializing provision-vagrant. One of the following files did not get created: #{target_file_list}"
+        help(msg)
+        exit(0)
+      end
+    end
+
+    def copy_vagrantfile_template
+      puts "Copying example Vagrantfile template to: #{target_vagrantfile_path}"
+      FileUtils.cp(source_vagrantfile_path, target_vagrantfile_path)
+    end
+
+    def copy_interpolated_post_hook
+      complete_opts = opts.merge(fetch_github_vars)
+      interpolator = Interpolator.new( { vars: complete_opts, input: post_hook_source_string })
+      interpolated = interpolator.interpolate
+      copy_post_hook_script(interpolated)
+    end
+
+    def copy_post_hook_script(interpolated)
+      puts "Copying example post hook bash script to: #{target_post_hook_path}"
+      ProvisionVagrant.write_string_to_File(interpolated, target_post_hook_path)
+    end
+
+    def copy_provision_vagrant_config
+      puts "Copying provision-vagrant config yml file to: #{target_provision_vagrant_config_path}"
+      FileUtils.cp(source_provision_vagrant_config_path, target_provision_vagrant_config_path)
+    end
+
+    def user_directory
+      @_user_directory ||= set_userdir
+    end
+
+    private
+
+    attr_accessor :opts
+
+    def source_vagrantfile_path
+      @_source_vagrantfile_path ||= File.join(Dir.pwd, "..", VAGRANTFILE_NAME)
+    end
+
+    def target_vagrantfile_path
+      @_target_vagrantfile_path ||= File.join(set_userdir, VAGRANTFILE_NAME)
+    end
+
+    def source_post_hook_path
+      @_source_post_hook_path ||= File.join(Dir.pwd, "..", POST_HOOK_FILE_NAME)
+    end
+
+    def target_post_hook_path
+      @_target_post_hook_path ||= File.join(set_userdir, POST_HOOK_FILE_NAME)
+    end
+
+    def source_provision_vagrant_config_path
+      @_source_provision_vagrant_config_path ||= File.join(Dir.pwd, "..", PROVISION_VAGRANT_CONFIG_FILE_NAME)
+    end
+
+    def target_provision_vagrant_config_path
+      @_target_provision_vagrant_config_path ||= File.join(set_userdir, PROVISION_VAGRANT_CONFIG_FILE_NAME)
+    end
+
+    def post_hook_source_string
+      @_post_hook_source_string ||= File.read(source_post_hook_path)
+    end
+
+    def options_klass_obj
+      @_options_klass_obj ||= Options.new
+    end
+
+    def set_userdir
+      # default to HOME environment variable
+      return ENV['HOME'] if ENV['HOME']
+
+      # fallback to use the first two dir paths ("/home/username")
+      current_dir = Dir.pwd
+      parts = current_dir.split("/")
+      base_path = File.join("/", parts[1], parts[2])
+
+      base_path
+    end
+
+    def fetch_github_vars
+      git_config = `git config --list`
+      unless git_config
+        msg = "There was a problem parsing your git config (\"git config --list\". Please ensure git is installed and configured."
+        help(msg)
+        exit(false)
+      end
+
+      github_vars = {}
+
+      lines = git_config.split("\n")
+      lines.each do |line|
+        next unless line && line.size > 0
+
+        var, value = *line.split('=')
+        if var == 'user.name'
+          github_vars[:github_name] = value
+        end
+
+        if var == 'user.email'
+          github_vars[:github_email] = value
+        end
+      end
+
+      github_vars
+    end
+
+    def help(msg = nil)
+      options_klass_obj.help(msg)
+    end
+
+    def target_file_list
+      target_paths = [
+        target_vagrantfile_path,
+        target_vagrantfile_path,
+        target_post_hook_path
+      ]
+      joined = target_paths.join("\n")
+
+      "\n#{joined}"
+    end
+
+    def read_default_config_opts
+      yaml_hash = YAML.load_file(source_provision_vagrant_config_path)
+      return {} unless yaml_hash && yaml_hash["configuration"]
+
+      yaml_hash["configuration"]
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: provision-vagrant
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Shanti Braford
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Easily spin up new Ubuntu/etc vagrant VM development boxes, provisioned
+  to your exact specs
+email:
+- shantibraford@gmail.com
+executables:
+- provision-vagrant
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/provision-vagrant
+- lib/generator.rb
+- lib/interpolator.rb
+- lib/options.rb
+- lib/provision_vagrant.rb
+- lib/pv_initializer.rb
+homepage: https://github.com/sbraford/provision-vagrant
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Opinionated vagrant box generator and provisioner for Ruby on Rails and beyond
+test_files: []