completely 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a935ee0ae2ceb0c9c7b1f579c876a97068c45f133cfeaebcc2e6a6578216af22
-  data.tar.gz: 624cc5668dd558f54aa8d66e6b6af765131c2f0a2442fe3c024247a52687a2fa
+  metadata.gz: b40f2059243b2820d2ce140394be5551e5ddb131351adb35d26343841f8a54c7
+  data.tar.gz: 71e01f5c44395f97023afff5a1822c5fa651efb98155a3b8dd05f750a19a5419
 SHA512:
-  metadata.gz: 0a08c66582789427539a284b8b7e037643178cdfc602ea2621366fcd0de37bba34a6bd05a712ac5243e5538ddf19cc042549a9c6ecce1694cf8dabf5189f6e75
-  data.tar.gz: e654bff7e530d8cb5414a1bcefe52081542041c57387c2b71cf61d8d49f26b2b8b5df96c648b51fa83594c828f597f8f0f814e7f6760fac3cc8f5c8fb5b76aa0
+  metadata.gz: 71d90d706eb26933817483395670eb5d5ed516b606b62c1f4b9408afdec92b977142e4b2501ff12b75bb47fa971e558696ef5294a3c569f3856da8cb9904254f
+  data.tar.gz: df1e950e2f839a977181521bb09fb917e6d47046f4f6b80d7a8dfc557b2c5d67ee66f962b7a23fd2456137a283bae6ffc9fe38e9ad97355c53c82a1ec84cff7a

data/README.md

@@ -109,7 +109,7 @@ $ completely generate
 $ completely preview
 ```
 
-For more options (like setting input/output path), run
+For more options (like setting input/output path), run:
 
 ```bash
 $ completely --help
@@ -215,9 +215,15 @@ In order to enable the completions, simply source the generated script:
 $ source completely.bash
 ```
 
-In order to load these completions on startup, you may want to place them in 
-the completions directory of your operating system, which can be either of
-these (whichever exists):
+If you are satisfied with the result, and wish to copy the script to your bash
+completions directory, simply run:
+
+```bash
+$ completely install
+```
+
+Alternatively, you can copy the script manually to one of these directories
+(whichever exists):
 
 - `/usr/share/bash-completion/completions`
 - `/usr/local/etc/bash_completion.d`

data/lib/completely/cli.rb

@@ -1,9 +1,10 @@
 require 'mister_bin'
+require 'completely/version'
+require 'completely/commands/generate'
 require 'completely/commands/init'
+require 'completely/commands/install'
 require 'completely/commands/preview'
-require 'completely/commands/generate'
 require 'completely/commands/test'
-require 'completely/version'
 
 module Completely
   class CLI
@@ -16,6 +17,7 @@ module Completely
       runner.route 'preview',   to: Commands::Preview
       runner.route 'generate',  to: Commands::Generate
       runner.route 'test',      to: Commands::Test
+      runner.route 'install',   to: Commands::Install
 
       runner
     end

data/lib/completely/commands/init.rb

@@ -12,7 +12,7 @@ module Completely
       environment_config_path
 
       def run
-        raise "File already exists: #{config_path}" if File.exist? config_path
+        raise Error, "File already exists: #{config_path}" if File.exist? config_path
 
         File.write config_path, sample
         say "Saved m`#{config_path}`"

data/lib/completely/commands/install.rb

@@ -0,0 +1,46 @@
+require 'completely/commands/base'
+
+module Completely
+  module Commands
+    class Install < Base
+      summary 'Install a bash completion script'
+
+      help <<~HELP
+        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
+
+      usage 'completely install PROGRAM [SCRIPT_PATH --force --dry]'
+      usage 'completely install (-h|--help)'
+
+      option '-f --force', 'Overwrite target file if it exists'
+      option '-d --dry', 'Show the installation command but do not run it'
+
+      param 'PROGRAM', 'Name of the program the completions are for.'
+      param 'SCRIPT_PATH', 'Path to the source bash script [default: completely.bash].'
+
+      def run
+        if args['--dry']
+          puts installer.command_string
+          return
+        end
+
+        success = installer.install force: args['--force']
+        raise InstallError, "Failed running command:\nnb`#{installer.command_string}`" unless success
+
+        say "Saved m`#{installer.target_path}`"
+        say 'You may need to restart your session to test it'
+      end
+
+    private
+
+      def installer
+        Installer.new program: args['PROGRAM'], script_path: script_path
+      end
+
+      def script_path
+        args['SCRIPT_PATH'] || 'completely.bash'
+      end
+    end
+  end
+end

data/lib/completely/exceptions.rb

@@ -0,0 +1,4 @@
+module Completely
+  class Error < StandardError; end
+  class InstallError < Error; end
+end

data/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 InstallError, 'Cannot determine system completions directory'
+      end
+
+      unless script_exist?
+        raise InstallError, "Cannot find script: m`#{script_path}`"
+      end
+
+      if target_exist? && !force
+        raise InstallError, "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

data/lib/completely/templates/template.erb

@@ -33,7 +33,7 @@
     echo "cur:      '$cur'" >> 'completely-debug.txt'
   fi
 
-%end
+% end
   case "$compline" in
 % patterns.each do |pattern|
 % next if pattern.empty?

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 end

data/lib/completely.rb

@@ -3,6 +3,8 @@ if ENV['BYEBUG']
   require 'lp'
 end
 
+require 'completely/exceptions'
 require 'completely/pattern'
 require 'completely/completions'
 require 'completely/tester'
+require 'completely/installer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -58,19 +58,25 @@ files:
 - lib/completely/commands/base.rb
 - lib/completely/commands/generate.rb
 - lib/completely/commands/init.rb
+- lib/completely/commands/install.rb
 - lib/completely/commands/preview.rb
 - lib/completely/commands/test.rb
 - lib/completely/completions.rb
+- lib/completely/exceptions.rb
+- lib/completely/installer.rb
 - lib/completely/pattern.rb
 - lib/completely/templates/sample.yaml
 - lib/completely/templates/template.erb
 - lib/completely/templates/tester-template.erb
 - lib/completely/tester.rb
 - lib/completely/version.rb
-homepage: https://github.com/dannyben/completely
+homepage: https://github.com/DannyBen/completely
 licenses:
 - MIT
 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'
 post_install_message: 
 rdoc_options: []
@@ -80,14 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.4.14
 signing_key: 
 specification_version: 4
 summary: Bash Completions Generator