gene_system 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69b1b6ad105f91562009bfa99f1a2cc3a3dfd0391a54a4e58b65296cc452e581
-  data.tar.gz: de398efc98b4de7eb7f3b8a8661790f5ca9f89cf55165abc89a7ec0b97b3986c
+  metadata.gz: 559379df624aadc40f65cb1c3c9ab01f152fbbbaa238e1b5e2f71fcb97d84874
+  data.tar.gz: a0dbf8ab2cba60a31d8022601922660d93c87d8e6bf3c0a2653c344ce9e6aeed
 SHA512:
-  metadata.gz: b3936aa6de8f87fec7fbabfa7574e7ab15a0252a7f653efb163bf78a341eb0451766b32db7e2b3616583589116f863e1e7747331f8cc3e6a5af0aa965c01e6bb
-  data.tar.gz: 524c443a8ee2425184e70072336e4d99f6b3716f14864c723164ecc7d422a1fcab722edb0b212741be7cf71964245699b80990e6eb8ec77311c9b5850f8f3533
+  metadata.gz: 79a46d8e6cfbe40d422ba6fdb8c7de1575dd52a94664c4550e4cfc54f5f9be72a0d541137e0dee65cbc535ea98a02a8d5f57e698f0ca3e23e5c9b5531815a83d
+  data.tar.gz: f052a0aea8250f8ec4e6a412c0a4af883f315ef2a2e6a85021cbcded1adfab4165a9efdc3c92d95d0c98b56ae64ff053a0e2ed289d0342c0a783e4ecab338ae9

data/Gemfile

@@ -1,10 +1,3 @@
 source 'https://rubygems.org'
 
-git_source(:biggerconcept) do |repo_name|
-  username = ENV['BIGGERCONCEPT_CI_USER']
-  password = ENV['BIGGERCONCEPT_CI_PASSWORD']
-  git_host = ENV['BIGGERCONCEPT_GIT_HOSTpro']
-  "https://#{username}:#{password}@#{git_host}/#{repo_name}"
-end
-
 gemspec

data/Gemfile.lock

@@ -1,18 +1,20 @@
 PATH
   remote: .
   specs:
-    gene_system (0.3.2)
+    gene_system (0.4.0)
       hashie
       highline (~> 2.0)
       jsonnet
       logger (~> 1.4)
       os
       ruby-handlebars (~> 0.4)
+      thor (~> 1.0)
+      tty-prompt
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     axiom-types (0.1.1)
@@ -21,15 +23,14 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     bump (0.10.0)
     byebug (11.1.3)
-    codeclimate-engine-rb (0.4.1)
-      virtus (~> 1.0)
+    codeclimate-engine-rb (0.4.2)
     coderay (1.1.3)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.4.4)
-    docile (1.3.5)
+    docile (1.4.0)
     doxie (4.0.0)
     equalizer (0.0.11)
     erubis (2.7.0)
@@ -42,7 +43,7 @@ GEM
       path_expander (~> 1.0)
       ruby_parser (~> 3.1, > 3.1.0)
       sexp_processor (~> 4.8)
-    hashie (4.1.0)
+    hashie (5.0.0)
     highline (2.0.3)
     ice_nine (0.11.2)
     jaro_winkler (1.5.4)
@@ -50,15 +51,17 @@ GEM
       mini_portile2 (>= 2.2.0)
     launchy (2.4.3)
       addressable (~> 2.3)
-    logger (1.4.3)
+    logger (1.4.4)
     method_source (1.0.0)
-    mini_portile2 (2.6.1)
-    nio4r (2.5.7)
-    os (1.1.1)
-    parallel (1.20.1)
+    mini_portile2 (2.7.1)
+    nio4r (2.5.8)
+    os (1.1.4)
+    parallel (1.21.0)
     parser (2.5.3.0)
       ast (~> 2.4.0)
     parslet (1.8.2)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
     path_expander (1.1.0)
     private_gem (1.1.4)
       bundler (> 1.7, < 3.0)
@@ -67,10 +70,10 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    puma (4.3.7)
+    puma (4.3.10)
       nio4r (~> 2.0)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     reek (4.8.2)
       codeclimate-engine-rb (~> 0.4.0)
       parser (>= 2.5.0.0, < 2.6)
@@ -87,7 +90,7 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
     rubocop (0.68.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -98,8 +101,8 @@ GEM
     ruby-handlebars (0.4.0)
       parslet (~> 1.6, >= 1.6.2)
     ruby-progressbar (1.11.0)
-    ruby_parser (3.15.1)
-      sexp_processor (~> 4.9)
+    ruby_parser (3.18.1)
+      sexp_processor (~> 4.16)
     rubycritic (3.5.2)
       flay (~> 2.8)
       flog (~> 4.4)
@@ -110,7 +113,7 @@ GEM
       ruby_parser (~> 3.8)
       tty-which (~> 0.3.0)
       virtus (~> 1.0)
-    sexp_processor (4.15.2)
+    sexp_processor (4.16.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -119,6 +122,16 @@ GEM
     simplecov_json_formatter (0.1.3)
     thor (1.1.0)
     thread_safe (0.3.6)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
     tty-which (0.3.0)
     unicode-display_width (1.5.0)
     virtus (1.0.5)
@@ -126,6 +139,7 @@ GEM
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
+    wisper (2.0.1)
     yard (0.9.26)
 
 PLATFORMS
@@ -147,4 +161,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.16
+   2.2.27

data/README.md

@@ -1,5 +1,7 @@
 # GeneSystem
 
+[![Ruby](https://github.com/andrewbigger/gene_system/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/andrewbigger/gene_system/actions/workflows/build.yml)
+
 A gem for configuring systems via json or jsonnet manifest.
 
 ## Installation

data/bin/gene_system

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'pry'
+require 'gene_system/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  GeneSystem::CLI.start
+rescue StandardError => e
+  puts "ERROR: #{e.message}"
+  puts e.backtrace.join("\n")
+  exit 1
+end

data/bin/genesystem

@@ -1,52 +1,20 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift(__dir__ + '/../lib')
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
-require 'rubygems'
-require 'optparse'
-require 'highline'
-
-require 'gene_system'
+require 'pry'
 require 'gene_system/cli'
 
-USAGE = "GeneSystem system configuration tool
-
-Usage:\tgenesystem <command> <variables> <opts>
-Options:
-  \s\s\s\s--trace\t\t trace mode on
-  -h, --help\t\t print usage
-
-Commands:
-  new <rel>\t\t creates a new manifest
-  install <rel>\t\t applies install steps specified in manifest
-  remove <rel>\t\t applies remove steps specified in manifest
-".freeze
-
-@trace = false
-@overwrite = false
-
-OptionParser.new do |opts|
-  opts.banner = USAGE
-  opts.on('--trace') { @trace = true }
-
-  opts.on_tail('-h', '--help') do
-    GeneSystem::CLI.print_message_and_exit(USAGE)
-  end
-end.parse!
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
 
 begin
-  raise 'ERROR: no command provided' unless ARGV[0]
-
-  cmd = ARGV.shift
-  GeneSystem::CLI::Commands.public_send(
-    cmd.to_sym,
-    ARGV
-  )
+  GeneSystem::CLI.start
 rescue StandardError => e
-  GeneSystem::CLI.print_message(e)
-  GeneSystem::CLI.print_message(e.backtrace) if @trace
-  GeneSystem::CLI.print_message("\n")
-  GeneSystem::CLI.print_message_and_exit(USAGE)
+  puts "ERROR: #{e.message}"
+  puts e.backtrace.join("\n")
+  exit 1
 end
-
-exit(0)

data/gene_system.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = GeneSystem::VERSION
   spec.authors       = ['Andrew Bigger']
   spec.email         = ['andrew.bigger@gmail.com']
-  spec.summary       = 'System configuration tool for applying personal settings to a new machine.'
+  spec.summary       = 'System configuration tool for applying settings'
   spec.homepage      = 'https://github.com/andrewbigger/gene_system'
   spec.license       = 'MIT'
 
@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'logger', '~> 1.4'
   spec.add_dependency 'os'
   spec.add_dependency 'ruby-handlebars', '~> 0.4'
+  spec.add_dependency 'thor', '~> 1.0'
+  spec.add_dependency 'tty-prompt'
 
   spec.add_development_dependency 'bump', '~> 0.6'
   spec.add_development_dependency 'byebug', '~> 11.0'

data/lib/gene_system/cli.rb

@@ -1,76 +1,64 @@
-require 'gene_system/cli/commands'
+require 'thor'
+require 'gene_system'
+require 'gene_system/commands'
 
 require 'hashie'
 
 module GeneSystem
   # Command line interface helpers and actions
-  module CLI
-    # CLI Helpers
-    class <<self
-      ##
-      # Creates logger for printing messages
-      #
-      # Sets the formatter to output only the provided message to the
-      # specified IO
-      #
-      # @param [IO] out - default: STDOUT
-      #
-      # @return [Logger]
-      #
-      def logger(out = STDOUT)
-        @logger ||= Logger.new(out)
-        @logger.formatter = proc do |_sev, _time, _prog, msg|
-          "#{msg}\n"
-        end
+  class CLI < Thor
+    package_name 'GeneSystem'
 
-        @logger
-      end
+    desc 'version', 'Print gem version'
 
-      ##
-      # Prints command line message to STDOUT
-      #
-      # For use when printing info messages for a user to STDOUT
-      #
-      # @param [String] message - message to be printed
-      #
-      def print_message(message)
-        logger.info(message)
-      end
+    def version
+      cmd = GeneSystem::Commands::PrintVersion.new(options)
+      cmd.run
+    end
+
+    desc 'new', 'Create new manifest'
+
+    method_option(
+      :out,
+      type: :string,
+      desc: 'Path to folder for manifest'
+    )
+
+    method_option(
+      :name,
+      type: :string,
+      desc: 'Name of manifest (i.e. manifest.json)'
+    )
+
+    def new
+      cmd = GeneSystem::Commands::CreateManifest.new(options)
+      cmd.run
+    end
+
+    desc 'install', 'Applies install instructions from given manifest'
+
+    method_option(
+      :manifest,
+      type: :string,
+      desc: 'Path to manifest (i.e. manifest.json)'
+    )
+
+    def install
+      cmd = GeneSystem::Commands::InstallManifest.new(options)
+      cmd.run
+    end
 
-      ##
-      # Prints warning to STDOUT
-      #
-      # For use when printing warn messages to STDOUT
-      #
-      # @param [String] message - message to be printed
-      #
-      def print_warning(message)
-        logger.warn(message)
-      end
+    desc 'remove', 'Applies remove instructions from given manifest'
 
-      ##
-      # Prints error to STDERR
-      #
-      # For indicating fatal message to user
-      #
-      # @param [String] message - message to be printed
-      #
-      def print_error(message)
-        logger(STDERR).error(message)
-      end
+    method_option(
+      :manifest,
+      type: :string,
+      desc: 'Path to manifest (i.e. manifest.json)'
+    )
 
-      ##
-      # Prints a message and then exits with given status code
-      #
-      # This will terminate the program with the given status code
-      #
-      # @param [String] message - message to be printed
-      # @param [Integer] exit_code - exit status (default: 1)
-      #
-      def print_message_and_exit(message, exit_code = 1)
-        print_message(message)
-        exit(exit_code)
-      end
+    def remove
+      cmd = GeneSystem::Commands::RemoveManifest.new(options)
+      cmd.run
     end
   end
 end

data/lib/gene_system/commands/create_manifest.rb

@@ -0,0 +1,54 @@
+module GeneSystem
+  module Commands
+    # Create manifest command
+    class CreateManifest
+      ##
+      # Default name of gene system manifest
+      #
+      DEFAULT_MANIFEST_NAME = 'manifest.json'.freeze
+
+      def initialize(options)
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Creates a new, blank manifest with at the specified
+      # destination with the specified name.
+      #
+      # If the options are not provided the user will be prompted
+      # for the manifest name and location.
+      #
+      # If the output location is not a directory then a
+      # RuntimeError will be raised.
+      #
+      # When successfully rendered a success message will be
+      # printed to STDOUT.
+      #
+      def run
+        manifest_name = @options.name
+        manifest_name ||= @prompt.ask(
+          'Please enter the name of the manifest',
+          default: DEFAULT_MANIFEST_NAME
+        )
+
+        output_location = @options.out
+        output_location ||= @prompt.ask(
+          'Please specify output location',
+          default: Dir.pwd
+        )
+
+        unless File.directory?(output_location)
+          raise 'output location must be a folder'
+        end
+
+        GeneSystem::Generators.render_empty_manifest(
+          manifest_name,
+          output_location
+        )
+
+        puts "✔ Manifest successfully created in #{output_location}"
+      end
+    end
+  end
+end

data/lib/gene_system/commands/install_manifest.rb

@@ -0,0 +1,86 @@
+module GeneSystem
+  module Commands
+    # Install manifest command
+    class InstallManifest
+      ##
+      # Default name of gene system manifest
+      #
+      DEFAULT_MANIFEST_NAME = 'manifest.json'.freeze
+
+      def initialize(options)
+        @options = options
+        @prompt = TTY::Prompt.new
+        @manifest = nil
+      end
+
+      ##
+      # Applies install instructions from a manifest
+      # to the host system.
+      #
+      def run
+        manifest_path = @options.manifest
+        manifest_path ||= @prompt.ask(
+          'Please enter the path to the configuration manifest',
+          default: DEFAULT_MANIFEST_NAME
+        )
+
+        @manifest = GeneSystem::Manifest.new_from_file(manifest_path)
+        platform = GeneSystem::Platform.new
+
+        puts("INSTALL #{@manifest.name_and_version}")
+
+        @manifest.steps.each do |step|
+          next if skip?(step, platform)
+
+          vars = ask(step.install.prompts)
+
+          platform.execute_commands(
+            step.install.cmd,
+            vars
+          )
+        end
+
+        puts(
+          "✔ Manifest #{@manifest.name_and_version} successfully installed"
+        )
+      end
+
+      private
+
+      ##
+      # Asks for user input when given prompts
+      #
+      # @param prompts [Array]
+      #
+      # @return Hashie::Mash
+      #
+      def ask(prompts = [])
+        answers = @manifest.variables
+        return answers if prompts.nil? || prompts.empty?
+
+        prompts.each do |prompt|
+          resp = @prompt.ask(prompt.prompt)
+          answers[prompt.var] = resp
+        end
+
+        answers
+      end
+
+      ##
+      # Determines whether to skip a step
+      #
+      # @param [GeneSystem::Step] step
+      # @param [GeneSystem::Platform] platform
+      #
+      # @return [Boolean]
+      #
+      def skip?(step, platform)
+        return false if step.install.skip.nil?
+
+        platform.execute_command(
+          step.install.skip
+        ).zero?
+      end
+    end
+  end
+end

data/lib/gene_system/commands/print_version.rb

@@ -0,0 +1,17 @@
+module GeneSystem
+  module Commands
+    # Gem version command
+    class PrintVersion
+      def initialize(options)
+        @options = options
+      end
+
+      ##
+      # Prints version to STDOUT
+      #
+      def run
+        puts(GeneSystem::VERSION)
+      end
+    end
+  end
+end

data/lib/gene_system/commands/remove_manifest.rb

@@ -0,0 +1,86 @@
+module GeneSystem
+  module Commands
+    # Remove manifest command
+    class RemoveManifest
+      ##
+      # Default name of gene system manifest
+      #
+      DEFAULT_MANIFEST_NAME = 'manifest.json'.freeze
+
+      def initialize(options)
+        @options = options
+        @prompt = TTY::Prompt.new
+        @manifest = nil
+      end
+
+      ##
+      # Applies remove instructions from a manifest
+      # to the host system.
+      #
+      def run
+        manifest_path = @options.manifest
+        manifest_path ||= @prompt.ask(
+          'Please enter the path to the configuration manifest',
+          default: DEFAULT_MANIFEST_NAME
+        )
+
+        @manifest = GeneSystem::Manifest.new_from_file(manifest_path)
+        platform = GeneSystem::Platform.new
+
+        puts("REMOVE #{@manifest.name_and_version}")
+
+        @manifest.steps.each do |step|
+          next if skip?(step, platform)
+
+          vars = ask(step.remove.prompts)
+
+          platform.execute_commands(
+            step.remove.cmd,
+            vars
+          )
+        end
+
+        puts(
+          "✔ Manifest #{@manifest.name_and_version} successfully removed"
+        )
+      end
+
+      private
+
+      ##
+      # Asks for user input when given prompts
+      #
+      # @param prompts [Array]
+      #
+      # @return Hashie::Mash
+      #
+      def ask(prompts = [])
+        answers = @manifest.variables
+        return answers if prompts.nil?
+
+        prompts.each do |prompt|
+          resp = @prompt.ask(prompt.prompt)
+          answers[prompt.var] = resp
+        end
+
+        answers
+      end
+
+      ##
+      # Determines whether to skip a step
+      #
+      # @param [GeneSystem::Step] step
+      # @param [GeneSystem::Platform] platform
+      #
+      # @return [Boolean]
+      #
+      def skip?(step, platform)
+        return false if step.remove.skip.nil?
+
+        platform.execute_command(
+          step.remove.skip
+        ).zero?
+      end
+    end
+  end
+end

data/lib/gene_system/commands.rb

@@ -0,0 +1,14 @@
+require 'tty-prompt'
+require 'gene_system'
+
+COMMANDS = File.join(__dir__, 'commands', '*.rb')
+
+Dir[COMMANDS].sort.each do |file|
+  require file
+end
+
+module GeneSystem
+  # Gem command module
+  module Commands
+  end
+end

data/lib/gene_system/generators.rb

@@ -45,7 +45,7 @@ module GeneSystem
       # @param [String] path
       #
       def render_empty_manifest(name, path)
-        manifest_path = File.join(path, "#{name}.json")
+        manifest_path = File.join(path, name)
 
         File.open(manifest_path, 'w') do |f|
           f.write(