gene_system 0.3.2

data/Rakefile

@@ -0,0 +1,19 @@
+require 'private_gem/tasks'
+require 'bundler/gem_tasks'
+require 'bump/tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'rubycritic/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+RubyCritic::RakeTask.new do |task|
+  task.paths = FileList['lib/**/*.rb'] - FileList['spec/**/*_spec.rb']
+  task.options = '--no-browser --path ./target/reports/critique'
+end
+
+YARD::Rake::YardocTask.new
+
+task default: %i[spec rubocop rubycritic yard]

data/bin/genesystem

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(__dir__ + '/../lib')
+
+require 'rubygems'
+require 'optparse'
+require 'highline'
+
+require 'gene_system'
+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!
+
+begin
+  raise 'ERROR: no command provided' unless ARGV[0]
+
+  cmd = ARGV.shift
+  GeneSystem::CLI::Commands.public_send(
+    cmd.to_sym,
+    ARGV
+  )
+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)
+end
+
+exit(0)

data/data/manifest.jsonnet

@@ -0,0 +1,87 @@
+local conf = {
+  variables: {
+    apps: [
+      {
+        "name": "virtualbox",
+        "version": "6.0.1",
+      },
+      {
+        "name": "vagrant",
+        "version": "9.0.2",
+      },
+    ],
+
+    bins: [
+      "libc",
+      "libd",
+      "libe"
+    ]
+  }
+};
+
+{
+  "name": "macos_ruby_dev",
+  "version": "0.1.1",
+  "platform": "macos",
+  "metadata": {
+    "gene_system": {
+      "version": "0.1.0"
+    },
+  },
+  "steps": [
+    // install apps
+    {
+      "name": "install " + app.name,
+      "exe": {
+        "install": {
+          "skip": "which yolo",
+          "cmd": [
+            "echo install " + app.name + app.version 
+          ],
+        },
+        "remove": {
+          "cmd": [
+            "echo remove " + app.name + app.version 
+          ],
+        },
+      },
+      "tags": "app " + app.name
+    } for app in conf.variables.apps
+  ] + [
+    // install bins
+    {
+      "name": "install " + bin,
+      "exe": {
+        "install": {
+          "cmd": [
+            "echo install " + bin 
+          ],
+        },
+        "remove": {
+          "cmd": [
+            "echo remove " + bin 
+          ],
+        },
+      },
+      "tags": "app " + bin
+    } for bin in conf.variables.bins
+  ] + [
+    {
+      "name": "ask for input",
+      "exe": {
+        "install": {
+          "prompts": [
+            {
+              "prompt": "Please enter your name",
+              "var": "name",
+            },
+          ],
+          "cmd": [
+            "echo 'Hello {{name}}'"
+          ],
+        },
+      },
+      "tags": "input"
+    },
+  ],
+}

data/gene_system.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gene_system/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gene_system'
+  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.homepage      = 'https://github.com/andrewbigger/gene_system'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'highline', '~> 2.0'
+  spec.add_dependency 'jsonnet'
+  spec.add_dependency 'logger', '~> 1.4'
+  spec.add_dependency 'os'
+  spec.add_dependency 'ruby-handlebars', '~> 0.4'
+
+  spec.add_development_dependency 'bump', '~> 0.6'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'doxie'
+  spec.add_development_dependency 'private_gem', '~> 1.1'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'puma', '~> 4.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.7', '>= 3.7.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58'
+  spec.add_development_dependency 'rubycritic', '~> 3.4', '>= 3.4.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/lib/gene_system.rb

@@ -0,0 +1,9 @@
+require 'gene_system/version'
+require 'gene_system/generators'
+require 'gene_system/manifest'
+require 'gene_system/step'
+require 'gene_system/platform'
+
+# GeneSystem is the namespace for gene_system
+module GeneSystem
+end

data/lib/gene_system/cli.rb

@@ -0,0 +1,76 @@
+require 'gene_system/cli/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
+
+        @logger
+      end
+
+      ##
+      # 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
+
+      ##
+      # 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
+
+      ##
+      # 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
+
+      ##
+      # 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
+    end
+  end
+end

data/lib/gene_system/cli/commands.rb

@@ -0,0 +1,109 @@
+require 'highline'
+
+module GeneSystem
+  module CLI
+    # CLI Actions
+    module Commands
+      class <<self
+        ##
+        # Creates a new, blank manifest with at the specified
+        # destination with the given name
+        #
+        # It is expected that the first argument provided to the
+        # command will be the name of the manifest. If this is not
+        # provided then a RuntimeError will be raised.
+        #
+        # @param dest [String]
+        # @param args [Array]
+        #
+        def new(args = [])
+          manifest_name = args.shift
+
+          raise 'no manifest name provided' unless manifest_name
+
+          GeneSystem::Generators.render_empty_manifest(
+            manifest_name,
+            Dir.pwd
+          )
+        end
+
+        ##
+        # Applies install instructions from a manifest to the host system
+        #
+        # @param args [Array]
+        #
+        def install(args = [])
+          manifest = load_manifest(args)
+          platform = GeneSystem::Platform.new
+
+          manifest.steps.each do |step|
+            next if skip?(step, platform)
+
+            vars = ask(step.install.prompts)
+            platform.execute_commands(step.install.cmd, vars)
+          end
+
+          GeneSystem::CLI.print_message("\nmanifest successfully installed")
+        end
+
+        ##
+        # Asks for user input when given prompts
+        #
+        # @param prompts [Array]
+        #
+        # @return Hashie::Mash
+        #
+        def ask(prompts = [])
+          answers = Hashie::Mash.new
+          return answers if prompts.nil?
+
+          cli = HighLine.new
+
+          prompts.each do |prompt|
+            resp = cli.ask(prompt.prompt)
+            answers[prompt.var] = resp
+          end
+
+          answers
+        end
+
+        ##
+        # Applies remove instructions from a manifest to the host system
+        #
+        # @param args [Array]
+        #
+        def remove(args = [])
+          manifest = load_manifest(args)
+          platform = GeneSystem::Platform.new
+
+          manifest.steps.each do |step|
+            platform.execute_commands(step.remove.cmd)
+          end
+
+          GeneSystem::CLI.print_message("\nmanifest successfully removed")
+        end
+
+        private
+
+        def load_manifest(args)
+          manifest_rel = args.shift
+          raise 'no manifest path provided' unless manifest_rel
+
+          manifest_path = File.join(Dir.pwd, manifest_rel)
+
+          unless File.exist?(manifest_path)
+            raise "cannot find manifest at #{manifest_path}"
+          end
+
+          GeneSystem::Manifest.new_from_file(manifest_path)
+        end
+
+        def skip?(step, platform)
+          return false if step.install.skip.nil?
+
+          platform.execute_command(step.install.skip).zero?
+        end
+      end
+    end
+  end
+end

data/lib/gene_system/generators.rb

@@ -0,0 +1,58 @@
+require 'json'
+
+module GeneSystem
+  # Generators create empty projects for the gene_system gem
+  module Generators
+    # Default sample step
+    DEFAULT_STEP = {
+      'name' => 'say hello',
+      'exe' => {
+        'install' => {
+          'cmd' => [
+            'echo hello'
+          ]
+        },
+        'remove' => {
+          'cmd' => [
+            'echo goodbye'
+          ]
+        }
+      },
+      'tags' => 'example step'
+    }.freeze
+
+    # Function that creates a named, empty manifest
+    TEMPLATE_MANIFEST = lambda do |name|
+      {
+        'name' => name,
+        'version' => '0.0.1',
+        'metadata' => {
+          'gene_system' => {
+            'version' => GeneSystem::VERSION
+          }
+        },
+        'steps' => [
+          DEFAULT_STEP
+        ]
+      }
+    end
+
+    class <<self
+      ##
+      # Renders empty manifest at specified path
+      #
+      # @param [String] name
+      # @param [String] path
+      #
+      def render_empty_manifest(name, path)
+        manifest_path = File.join(path, "#{name}.json")
+
+        File.open(manifest_path, 'w') do |f|
+          f.write(
+            TEMPLATE_MANIFEST.call(name).to_json
+          )
+        end
+      end
+    end
+  end
+end