Merge pull request #51 from DannyBen/add/installer-model

Refactor installer

Author: DannyBen

.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
-      matrix: { ruby: ['2.7', '3.0', '3.1', '3.2', head] }
+      matrix: { ruby: ['3.0', '3.1', '3.2', head] }
 
     steps:
     - name: Checkout code

.gitignore

@@ -3,11 +3,12 @@
 /completely.bash
 /completely.yaml
 /coverage
+/debug.runfile
 /dev
 /doc
 /Gemfile.lock
 /gems
+/out.sh
+/spec/status.txt
 /spec/tmp
-/debug.runfile
 /tmp
-out.sh

.rubocop.yml

@@ -8,7 +8,7 @@ inherit_gem:
     - rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   Exclude:
     - 'spec/approvals/**/*'
     - 'debug.rb'
@@ -18,8 +18,3 @@ AllCops:
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/completely/tester.rb'
-
-# The `bounce` method here is more readable without this cop
-Style/GuardClause:
-  Exclude:
-    - 'lib/completely/commands/install.rb'

completely.gemspec

@@ -11,13 +11,18 @@ Gem::Specification.new do |s|
   s.email       = '[email protected]'
   s.files       = Dir['README.md', 'lib/**/*.*']
   s.executables = ['completely']
-  s.homepage    = 'https://github.com/dannyben/completely'
+  s.homepage    = 'https://github.com/DannyBen/completely'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.7.0'
+  s.required_ruby_version = '>= 3.0'
 
   s.add_runtime_dependency 'colsole', '>= 0.8.1', '< 2'
   s.add_runtime_dependency 'mister_bin', '~> 0.7'
 
-  s.metadata['rubygems_mfa_required'] = 'true'
+  s.metadata = {
+    'bug_tracker_uri'       => 'https://github.com/DannyBen/completely/issues',
+    'changelog_uri'         => 'https://github.com/DannyBen/completely/blob/master/CHANGELOG.md',
+    'source_code_uri'       => 'https://github.com/DannyBen/completely',
+    'rubygems_mfa_required' => 'true',
+  }
 end

lib/completely.rb

@@ -6,3 +6,4 @@
 require 'completely/pattern'
 require 'completely/completions'
 require 'completely/tester'
+require 'completely/installer'

lib/completely/commands/install.rb

@@ -3,19 +3,10 @@
 module Completely
   module Commands
     class Install < Base
-      TARGETS = %W[
-        /usr/share/bash-completion/completions
-        /usr/local/etc/bash_completion.d
-        #{Dir.home}/.bash_completion.d
-      ]
-
       summary 'Install a bash completion script'
 
       help <<~HELP
-        This command will copy the specified file to one of the following directories:
-
-        #{TARGETS.map { |c| "  - #{c}" }.join "\n"}
-
+        This command will copy the specified file to one of the bash completion directories.
         The target filename will be the program name, and sudo will be used if necessary.
       HELP
 
@@ -29,68 +20,27 @@ class Install < Base
       param 'SCRIPT_PATH', 'Path to the source bash script [default: completely.bash].'
 
       def run
-        bounce
-
         if args['--dry']
-          puts command.join ' '
+          puts installer.command_string
           return
         end
 
-        success = system(*command)
-        raise "Failed running command:\nnb`#{command.join ' '}`" unless success
+        success = installer.install force: args['--force']
+        raise "Failed running command:\nnb`#{installer.command_string}`" unless success
 
-        say "Saved m`#{target_path}`"
+        say "Saved m`#{installer.target_path}`"
         say 'You may need to restart your session to test it'
       end
 
     private
 
-      def bounce
-        unless completions_path
-          raise 'Cannot determine system completions directory'
-        end
-
-        unless File.exist? script_path
-          raise "Cannot find script: m`#{script_path}`"
-        end
-
-        if target_exist? && !args['--force']
-          raise "File exists: m`#{target_path}`\nUse nb`--force` to overwrite"
-        end
-      end
-
-      def target_exist?
-        File.exist? target_path
-      end
-
-      def command
-        result = root? ? [] : %w[sudo]
-        result + %W[cp #{script_path} #{target_path}]
+      def installer
+        Installer.new program: args['PROGRAM'], script_path: script_path
       end
 
       def script_path
         args['SCRIPT_PATH'] || 'completely.bash'
       end
-
-      def target_path
-        "#{completions_path}/#{args['PROGRAM']}"
-      end
-
-      def root?
-        Process.uid.zero?
-      end
-
-      def completions_path
-        @completions_path ||= completions_path!
-      end
-
-      def completions_path!
-        TARGETS.each do |tarnet|
-          return tarnet if Dir.exist? tarnet
-        end
-
-        nil
-      end
     end
   end
 end

lib/completely/installer.rb

@@ -0,0 +1,73 @@
+module Completely
+  class Installer
+    attr_reader :program, :script_path
+
+    def initialize(program:, script_path: nil)
+      @program = program
+      @script_path = script_path
+    end
+
+    def target_directories
+      @target_directories ||= %W[
+        /usr/share/bash-completion/completions
+        /usr/local/etc/bash_completion.d
+        #{Dir.home}/.bash_completion.d
+      ]
+    end
+
+    def command
+      result = root_user? ? [] : %w[sudo]
+      result + %W[cp #{script_path} #{target_path}]
+    end
+
+    def command_string
+      command.join ' '
+    end
+
+    def target_path
+      "#{completions_path}/#{program}"
+    end
+
+    def install(force: false)
+      unless completions_path
+        raise 'Cannot determine system completions directory'
+      end
+
+      unless script_exist?
+        raise "Cannot find script: m`#{script_path}`"
+      end
+
+      if target_exist? && !force
+        raise "File exists: m`#{target_path}`"
+      end
+
+      system(*command)
+    end
+
+  private
+
+    def target_exist?
+      File.exist? target_path
+    end
+
+    def script_exist?
+      File.exist? script_path
+    end
+
+    def root_user?
+      Process.uid.zero?
+    end
+
+    def completions_path
+      @completions_path ||= completions_path!
+    end
+
+    def completions_path!
+      target_directories.each do |target|
+        return target if Dir.exist? target
+      end
+
+      nil
+    end
+  end
+end

spec/approvals/cli/install/dry

@@ -1 +1 @@
-sudo cp README.md /usr/share/bash-completion/completions/completely-test
+sudo cp completely.bash /usr/share/bash-completion/completions/completely-test

spec/approvals/cli/install/help

@@ -1,11 +1,7 @@
 Install a bash completion script
 
-This command will copy the specified file to one of the following directories:
-
-  - /usr/share/bash-completion/completions
-  - /usr/local/etc/bash_completion.d
-  - /home/vagrant/.bash_completion.d
-
+This command will copy the specified file to one of the bash completion
+directories.
 The target filename will be the program name, and sudo will be used if
 necessary.
 

spec/approvals/cli/install/install

@@ -0,0 +1,2 @@
+Saved some-target-path
+You may need to restart your session to test it