gene_system 0.3.2 → 0.4.0

data/spec/gene_system/commands/print_version_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+RSpec.describe GeneSystem::Commands::PrintVersion do
+  let(:options) { double }
+
+  subject { described_class.new(options) }
+
+  describe '#run' do
+    before do
+      allow(subject).to receive(:puts)
+      subject.run
+    end
+
+    it 'prints version' do
+      expect(subject)
+        .to have_received(:puts)
+        .with(GeneSystem::VERSION)
+    end
+  end
+end

data/spec/gene_system/commands/remove_manifest_spec.rb

@@ -0,0 +1,258 @@
+require 'spec_helper'
+
+RSpec.describe GeneSystem::Commands::RemoveManifest do
+  let(:options) { Hashie::Mash.new }
+  let(:prompt) { double(TTY::Prompt) }
+  let(:version) { '1.0.0' }
+  let(:execute_command_result) { 0 }
+  let(:manifest_name) { 'some manifest' }
+
+  subject { described_class.new(options) }
+
+  before do
+    subject.instance_variable_set(:@prompt, prompt)
+  end
+
+  describe '#run' do
+    let(:platform) { double(GeneSystem::Platform) }
+
+    let(:manifest) do
+      double(
+        GeneSystem::Manifest,
+        name: manifest_name,
+        name_and_version: "#{manifest_name} v#{version}"
+      )
+    end
+
+    let(:skip_command) { 'false' }
+    let(:prompts) { [prompt_definition, prompt_definition] }
+    let(:prompt_definition) do
+      {
+        "prompt": 'Please enter your name',
+        "var": 'name'
+      }
+    end
+    let(:cmd) { 'echo {{name}}' }
+    let(:cmds) do
+      [
+        cmd
+      ]
+    end
+
+    let(:step_definition) do
+      {
+        "name": 'some step',
+        "exe": {
+          "remove": {
+            "skip": skip_command,
+            "prompts": prompts,
+            "cmd": cmds
+          }
+        }
+      }
+    end
+
+    let(:step) do
+      GeneSystem::Step.new(step_definition)
+    end
+
+    before do
+      allow(GeneSystem::Manifest)
+        .to receive(:new_from_file)
+        .and_return(manifest)
+
+      allow(GeneSystem::Platform)
+        .to receive(:new)
+        .and_return(platform)
+
+      allow(manifest)
+        .to receive(:steps)
+        .and_return([step, step])
+
+      allow(manifest)
+        .to receive(:version)
+        .and_return(version)
+
+      allow(manifest)
+        .to receive(:variables)
+        .and_return({})
+
+      allow(platform)
+        .to receive(:execute_commands)
+
+      allow(platform)
+        .to receive(:execute_command)
+        .and_return(execute_command_result)
+
+      allow(prompt).to receive(:ask).and_return(prompt_response)
+      allow(subject).to receive(:puts)
+    end
+
+    context 'when manifest path is provided' do
+      let(:manifest_path) { 'provided/path/to/manifest.json' }
+      let(:execute_command_result) { 1 }
+      let(:prompt_response) { 'Jon' }
+      let(:options) do
+        Hashie::Mash.new(
+          manifest: manifest_path
+        )
+      end
+
+      before do
+        subject.run
+      end
+
+      it 'loads manifest from expected file' do
+        expect(GeneSystem::Manifest)
+          .to have_received(:new_from_file)
+          .with(manifest_path)
+      end
+
+      it 'prints remove message' do
+        expect(subject)
+          .to have_received(:puts)
+          .with("REMOVE #{manifest_name} v#{version}")
+      end
+
+      describe 'skip steps' do
+        context 'when there is a skip command defined' do
+          it 'checks whether it should skip any steps' do
+            expect(platform)
+              .to have_received(:execute_command)
+              .with(skip_command).twice
+          end
+        end
+
+        context 'when there is no skip command defined' do
+          let(:step_definition) do
+            {
+              "name": 'some step',
+              "exe": {
+                "remove": {
+                  "skip": nil,
+                  "cmd": []
+                }
+              }
+            }
+          end
+
+          it 'does not try to run nil command' do
+            expect(platform)
+              .not_to have_received(:execute_command)
+          end
+        end
+
+        context 'when the skip command returns non zero' do
+          let(:execute_command_result) { 1 }
+          let(:prompts) { [] }
+
+          it 'does not execute step' do
+            expect(platform)
+              .not_to have_received(:execute_command)
+              .with(cmd)
+          end
+        end
+      end
+
+      describe 'prompting user for input' do
+        context 'when there are no prompts' do
+          let(:prompts) { [] }
+
+          it 'does not ask user for input' do
+            expect(prompt)
+              .not_to have_received(:ask)
+          end
+        end
+
+        context 'when there are prompts' do
+          it 'asks user for input' do
+            expect(prompt)
+              .to have_received(:ask)
+              .with('Please enter your name').exactly(4).times
+          end
+        end
+      end
+
+      it 'executes step commands' do
+        expect(platform)
+          .to have_received(:execute_commands)
+          .with(cmds, 'name' => prompt_response).twice
+      end
+
+      it 'prints success message' do
+        expect(subject)
+          .to have_received(:puts)
+          .with("✔ Manifest #{manifest_name} v#{version} successfully removed")
+      end
+    end
+
+    context 'when the manifest name is not provided' do
+      let(:prompt_response) { '/path/to/manifest.json' }
+
+      before do
+        allow(prompt)
+          .to receive(:ask)
+          .and_return(prompt_response)
+
+        subject.run
+      end
+
+      describe 'prompting user for manifest path' do
+        it 'prompts user for manifest path' do
+          expect(prompt)
+            .to have_received(:ask)
+            .with(
+              'Please enter the path to the configuration manifest',
+              default: 'manifest.json'
+            )
+        end
+      end
+
+      describe 'skipping steps' do
+        context 'when there is a skip command defined' do
+          it 'checks whether it should skip any steps' do
+            expect(platform)
+              .to have_received(:execute_command)
+              .with(skip_command).twice
+          end
+        end
+
+        context 'when there is no skip command defined' do
+          let(:step_definition) do
+            {
+              "name": 'some step',
+              "exe": {
+                "remove": {
+                  "skip": nil,
+                  "cmd": []
+                }
+              }
+            }
+          end
+
+          it 'does not try to run nil command' do
+            expect(platform)
+              .not_to have_received(:execute_command)
+          end
+        end
+
+        context 'when the skip command returns non zero' do
+          let(:execute_command_result) { 1 }
+          let(:prompts) { [] }
+
+          it 'does not execute step' do
+            expect(platform)
+              .not_to have_received(:execute_command)
+              .with(cmd)
+          end
+        end
+      end
+
+      it 'prints success message' do
+        expect(subject)
+          .to have_received(:puts)
+          .with("✔ Manifest #{manifest_name} v#{version} successfully removed")
+      end
+    end
+  end
+end

data/spec/gene_system/generators_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe GeneSystem::Generators do
     let(:name) { 'new_dev_setup' }
     let(:path) { 'path/to/manifests' }
 
-    let(:manifest_path) { File.join(path, "#{name}.json") }
+    let(:manifest_path) { File.join(path, name) }
     let(:manifest_file) { double }
 
     let(:manifest) { 'manifest' }

data/spec/gene_system/manifest_spec.rb

@@ -66,6 +66,24 @@ RSpec.describe GeneSystem::Manifest do
       end
     end
 
+    context 'when manifest is missing required attributes' do
+      let(:content) do
+        {
+          "steps": []
+        }.to_json
+      end
+
+      it 'raises missing required error' do
+        expect do
+          described_class.new_from_file(file_path)
+        end.to raise_error(
+          RuntimeError,
+          'manifest is missing required attributes name, '\
+          'version and/or metadata'
+        )
+      end
+    end
+
     context 'when manifest is from a later version of gene_system' do
       let(:gene_system_meta) do
         {
@@ -114,6 +132,26 @@ RSpec.describe GeneSystem::Manifest do
     end
   end
 
+  describe '#name_and_version' do
+    let(:path) { 'path/to/manifest.json' }
+
+    let(:data) do
+      {
+        'name' => 'test_manifest',
+        'version' => '0.1.0',
+        'steps' => []
+      }
+    end
+
+    before do
+      @manifest = described_class.new(path, data)
+    end
+
+    it 'returns name and version' do
+      expect(@manifest.name_and_version).to eq 'test_manifest v0.1.0'
+    end
+  end
+
   describe '#version' do
     let(:path) { 'path/to/manifest.json' }
 
@@ -236,4 +274,34 @@ RSpec.describe GeneSystem::Manifest do
       end
     end
   end
+
+  describe '#variables' do
+    let(:path) { 'path/to/manifest.json' }
+    let(:metadata) do
+      {
+        'gene_system' => {
+          'version' => '0.3.2'
+        }
+      }
+    end
+
+    let(:data) do
+      {
+        'name' => 'test_manifest',
+        'version' => '0.1.0',
+        'metadata' => metadata,
+        'steps' => []
+      }
+    end
+
+    before do
+      @manifest = described_class.new(path, data)
+    end
+
+    it 'returns hashie mash with manifest information' do
+      expect(@manifest.variables.manifest.name).to eq 'test_manifest'
+      expect(@manifest.variables.manifest.version).to eq '0.1.0'
+      expect(@manifest.variables.manifest.metadata).to eq metadata
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gene_system
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Bigger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -278,6 +306,7 @@ description:
 email:
 - andrew.bigger@gmail.com
 executables:
+- gene_system
 - genesystem
 extensions: []
 extra_rdoc_files: []
@@ -293,19 +322,28 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/gene_system
 - bin/genesystem
 - data/manifest.jsonnet
 - gene_system.gemspec
 - lib/gene_system.rb
 - lib/gene_system/cli.rb
-- lib/gene_system/cli/commands.rb
+- lib/gene_system/commands.rb
+- lib/gene_system/commands/create_manifest.rb
+- lib/gene_system/commands/install_manifest.rb
+- lib/gene_system/commands/print_version.rb
+- lib/gene_system/commands/remove_manifest.rb
 - lib/gene_system/generators.rb
 - lib/gene_system/manifest.rb
 - lib/gene_system/platform.rb
 - lib/gene_system/step.rb
 - lib/gene_system/version.rb
-- spec/gene_system/cli/commands_spec.rb
+- manifest.json
 - spec/gene_system/cli_spec.rb
+- spec/gene_system/commands/create_manifest_spec.rb
+- spec/gene_system/commands/install_manifest_spec.rb
+- spec/gene_system/commands/print_version_spec.rb
+- spec/gene_system/commands/remove_manifest_spec.rb
 - spec/gene_system/generators_spec.rb
 - spec/gene_system/manifest_spec.rb
 - spec/gene_system/platform_spec.rb
@@ -333,10 +371,13 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
-summary: System configuration tool for applying personal settings to a new machine.
+summary: System configuration tool for applying settings
 test_files:
-- spec/gene_system/cli/commands_spec.rb
 - spec/gene_system/cli_spec.rb
+- spec/gene_system/commands/create_manifest_spec.rb
+- spec/gene_system/commands/install_manifest_spec.rb
+- spec/gene_system/commands/print_version_spec.rb
+- spec/gene_system/commands/remove_manifest_spec.rb
 - spec/gene_system/generators_spec.rb
 - spec/gene_system/manifest_spec.rb
 - spec/gene_system/platform_spec.rb

data/lib/gene_system/cli/commands.rb

@@ -1,109 +0,0 @@
-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