kbsecret 1.3.0.pre.2 → 1.3.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62e332544af0910c66dda052deace55c038f308734a6f61327338c02bd6d0c6c
-  data.tar.gz: 8e436c956c7713519b6ade1085866b1669d42b6a26bbdc4655151e7b0f295017
+  metadata.gz: 917f766026ce5e43c4294706d146e44d159d0af0eebd4d088b8408bc85d7a6af
+  data.tar.gz: b7feb36ed986661d85076a19d1ad360ae099a2e0fadf09db9ccf6ba90b9fc84d
 SHA512:
-  metadata.gz: 22f83a0907bdd794f823ae45c8ad9a264a5083221a483eaa0f26322383f695d7c01d172158e3770b32c220ac95a29cd7942f7c5584e4d6f5d953d50a19c48649
-  data.tar.gz: 54112352f2a7b65a20deac137aaa52623f286d2e158dbf22d0c27c49ad5b3e3f444067a765ac8ff441dc3ea3d4a6e1d2832f532e2419a34cc3eb730301a425f1
+  metadata.gz: 59e7acebf02007b3ba23758496b5014723e2dfc9e735ae500bed07b83e2151e6f4462c5b156e6483dc1be867d5022efd911eff00d7202593baf45abf99941c89
+  data.tar.gz: 63e9b439194409c429a1fb404d18354f732520d33b0e7d95810b6acba14c052c8a036e1b6fb8128b4a18c922105f16270f92c012ef3092ea5ead2004d94b589d

data/README.md

@@ -3,7 +3,7 @@ KBSecret ![](https://avatars1.githubusercontent.com/u/31023996?s=50&v=4)
 
 [![Gem Version](https://badge.fury.io/rb/kbsecret.svg)](https://badge.fury.io/rb/kbsecret)
 [![Build Status](https://travis-ci.org/kbsecret/kbsecret.svg?branch=master)](https://travis-ci.org/kbsecret/kbsecret)
-[![Coverage Status](https://coveralls.io/repos/github/kbsecret/kbsecret/badge.svg)](https://coveralls.io/github/kbsecret/kbsecret?branch=coveralls)
+[![Coverage Status](https://codecov.io/gh/kbsecret/kbsecret/branch/master/graph/badge.svg)](https://codecov.io/gh/kbsecret/kbsecret)
 
 KBSecret is a command line utility and library for managing *secrets*.
 

data/bin/kbsecret

@@ -4,36 +4,13 @@
 require "kbsecret"
 require "fileutils"
 
-BUILTIN_CMDS = %w[help version commands types].freeze
-
-EXT_PATHS = ENV["PATH"].split(File::PATH_SEPARATOR).map do |path|
-  Dir[File.join(path, "kbsecret-*")]
-end.flatten.uniq.freeze
-
-EXT_CMDS = EXT_PATHS.map do |c|
-  File.basename(c, File.extname(c)).sub!("kbsecret-", "")
-end.freeze
-
-FLAGS = Hash.new { |_, k| k }.update(
+FLAG_ALIASES = Hash.new { |_, k| k }.update(
   "--help" => "help",
   "-h" => "help",
   "--version" => "version",
   "-v" => "version"
 ).freeze
 
-ALL_CMDS = (FLAGS.keys + BUILTIN_CMDS + KBSecret::CLI::Command.command_names + EXT_CMDS).freeze
-
-KBSECRET_HELP = <<~KBSECRET_HELP
-  Usage:
-    kbsecret <command> <args ...>
-
-  Available commands:
-    #{ALL_CMDS.join(", ")}
-
-  For more information about a particular command, try:
-    kbsecret help <command>
-KBSECRET_HELP
-
 def migrate_configs
   old_conf_dir = File.expand_path("~/.config/kbsecret")
 
@@ -43,104 +20,29 @@ def migrate_configs
   FileUtils.rm_rf old_conf_dir
 end
 
-def internal?(cmd)
-  KBSecret::CLI::Command.command_names.include?(cmd)
-end
-
-def external?(cmd)
-  EXT_CMDS.include?(cmd)
-end
-
-def builtin?(cmd)
-  BUILTIN_CMDS.include?(cmd)
-end
-
 def flag?(cmd)
-  FLAGS.keys.include?(cmd)
+  FLAG_ALIASES.keys.include?(cmd)
 end
 
 def normalize(cmd)
-  KBSecret::Config.unalias_command(FLAGS[cmd])
+  KBSecret::Config.unalias_command(FLAG_ALIASES[cmd])
 end
 
 def expand(cmd)
-  return cmd if flag?(cmd) || builtin?(cmd)
+  return cmd unless KBSecret::CLI::Command.external?(cmd)
 
   "kbsecret-#{cmd}"
 end
 
-def help(*args)
-  command = normalize args.shift
-  if command.nil?
-    puts KBSECRET_HELP
-  elsif builtin? command
-    send "#{command}_help"
-  elsif internal? command
-    exec expand(command), "--help"
-  elsif external? command
-    KBSecret::CLI.die "Help is not available for external commands."
-  else
-    KBSecret::CLI.die "Unknown command: #{command}."
-  end
-end
-
-# lol
-def help_help
-  puts <<~HELP_HELP
-    Usage:
-      kbsecret help <command>
-
-    For a list of all commands, see:
-      kbsecret help
-  HELP_HELP
-end
-
-def version(*_args)
-  puts <<~VERSION
-    kbsecret version #{KBSecret::VERSION}.
-  VERSION
-end
-
-def version_help
-  puts <<~VERSION_HELP
-    Usage:
-      kbsecret version
-  VERSION_HELP
-end
-
-def commands(*_args)
-  puts ALL_CMDS.join("\n")
-end
-
-def commands_help
-  puts <<~COMMANDS_HELP
-    Usage:
-      kbsecret commands
-  COMMANDS_HELP
-end
-
-def types(*_args)
-  puts KBSecret::Record.record_types.join("\n")
-end
-
-def types_help
-  puts <<~TYPES_HELP
-    Usage:
-      kbsecret types
-  TYPES_HELP
-end
-
 migrate_configs
 
 command = normalize(ARGV.shift || "help")
 
 args = KBSecret::Config.command_args(command) + ARGV
 
-if builtin?(command)
-  send command, *args
-elsif internal?(command)
+if KBSecret::CLI::Command.internal?(command)
   KBSecret::CLI::Command.run! command, *args
-elsif external?(command)
+elsif KBSecret::CLI::Command.external?(command)
   exec expand(command), *args
 else
   KBSecret::CLI.die "Unknown command: #{command}."

data/lib/kbsecret/cli/command/commands.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret commands`.
+      class Commands < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret commands [options]
+              HELP
+
+              o.bool "-e", "--external-only", "list only external commands"
+              o.bool "-i", "--internal-only", "list only internal commands"
+            end
+          end
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          cmds = if cli.opts.external_only?
+                   Command.external_command_names
+                 elsif cli.opts.internal_only?
+                   Command.internal_command_names
+                 else
+                   Command.all_command_names
+                 end
+
+          puts cmds.join "\n"
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/help.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret help`.
+      class Help < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret help <command>
+
+                For a list of all commands, see:
+                  kbsecret help
+              HELP
+            end
+
+            cli.dreck errors: false do
+              string :command
+            end
+          end
+        end
+
+        # @return [String] the top-level "help" string for `kbsecret`
+        def toplevel_help
+          <<~KBSECRET_HELP
+            Usage:
+              kbsecret <command> <args ...>
+
+            Available commands:
+              #{Command.all_command_names.join(", ")}
+
+            For more information about a particular command, try:
+              kbsecret help <command>
+          KBSECRET_HELP
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          command = cli.args[:command]
+
+          if command.empty?
+            puts toplevel_help
+          elsif Command.internal?(command)
+            Command.run! command, "--help"
+          elsif Command.external?(command)
+            cli.die "Help is not available for external commands."
+          else
+            cli.die "Unknown command: #{command}."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/new.rb

@@ -58,7 +58,7 @@ module KBSecret
           generator = KBSecret::Generator.new(cli.opts[:generator]) if cli.opts.generate?
 
           fields = if cli.opts.terse?
-                     STDIN.read.chomp.split cli.opts[:ifs]
+                     CLI.stdin.read.chomp.split cli.opts[:ifs]
                    else
                      prompt = TTY::Prompt.new
                      klass = Record.class_for(@type)

data/lib/kbsecret/cli/command/stash_file.rb

@@ -47,7 +47,7 @@ module KBSecret
         # @see Command::Abstract#run!
         def run!
           contents = if @filename == "-"
-                       STDIN.read
+                       KBSecret::CLI.stdin.read
                      elsif File.file?(@filename)
                        File.read(@filename)
                      end

data/lib/kbsecret/cli/command/types.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret types`.
+      class Types < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret types
+              HELP
+            end
+          end
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          puts KBSecret::Record.record_types.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/version.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret version`.
+      class Version < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret version
+              HELP
+            end
+          end
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          puts "kbsecret version #{KBSecret::VERSION}."
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command.rb

@@ -6,35 +6,67 @@ Dir[File.join(__dir__, "command/*.rb")].each { |t| require_relative t }
 
 module KBSecret
   class CLI
-    # The namespace for {KBSecret}'s internal commands.
+    # The namespace for {KBSecret}'s commands.
     module Command
       module_function
 
-      # @return [Array<Class>] the class objects of all non-abstract commands
-      def command_classes
+      # The fully-qualified paths of all external commands visible to {KBSecret}.
+      # @return [Array<String>] the fully-qualified paths of all external commands
+      def external_command_paths
+        ENV["PATH"].split(File::PATH_SEPARATOR).map do |path|
+          Dir[File.join(path, "kbsecret-*")]
+        end.flatten.uniq.freeze
+      end
+
+      # The CLI-friendly names of all external commands
+      def external_command_names
+        external_command_paths.map do |c|
+          File.basename(c, File.extname(c)).sub!("kbsecret-", "")
+        end.freeze
+      end
+
+      # @return [Boolean] whether or not there is an external command with the given name
+      def external?(command_name)
+        external_command_names.include?(command_name)
+      end
+
+      # @return [Array<Class>] the class objects of all non-abstract internal commands
+      def internal_command_classes
         klasses = constants.map(&Command.method(:const_get)).grep(Class)
         klasses.delete(Command::Abstract)
         klasses
       end
 
-      # @return [Array<String>] the CLI-friendly names of all commands
-      def command_names
-        command_classes.map(&:command_name)
+      # @return [Array<String>] the CLI-friendly names of all internal commands
+      def internal_command_names
+        internal_command_classes.map(&:command_name)
       end
 
       # @param command_name [String] the CLI-friendly name of the command
-      # @return [Class, nil] the command class corresponding to the given name, or `nil`
-      def command_for(command_name)
-        klass = command_classes.find { |c| c.command_name == command_name }
+      # @return [Class, nil] the command class corresponding to the given name, or `nil` if the name
+      #  does not correspond to an internal command
+      def internal_command_for(command_name)
+        klass = internal_command_classes.find { |c| c.command_name == command_name }
         # TODO: raise here if nil?
         klass
       end
 
-      # @param command_name [String] the CLI-friendly name of the command to run
+      # @return [Boolean] whether or not there is an internal command with the given name
+      def internal?(command_name)
+        internal_command_names.include?(command_name)
+      end
+
+      # @return [Array<String>] the CLI-friendly names of all commands, internal and external
+      def all_command_names
+        internal_command_names + external_command_names
+      end
+
+      # @param command_name [String] the CLI-friendly name of the internal command to run
       # @param args [Array<String>] the arguments, if any, to pass to the command
+      # @note This method only takes **internal** command names.
       # @return [void]
       def run!(command_name, *args)
-        klass = command_for command_name
+        klass = internal_command_for command_name
         cmd = klass.new(args)
         cmd.setup!
         cmd.validate!

data/lib/kbsecret/cli.rb

@@ -60,7 +60,7 @@ module KBSecret
       guard { yield self }
     end
 
-    # Parse options for a kbsecret utility, adding some default options for
+    # Parse options for a `kbsecret` command, adding some default options for
     #  introspection, verbosity, and help output.
     # @param cmds [Array<String>] additional commands to print in `--introspect-flags`
     # @param errors [Boolean] whether or not to produce Slop errors
@@ -91,7 +91,7 @@ module KBSecret
       @argv = @opts.args
     end
 
-    # Parse trailing arguments for a kbsecret utility, using the elements remaining
+    # Parse trailing arguments for a `kbsecret` command, using the elements remaining
     #  after options have been removed and interpreted via {#slop}.
     # @param errors [Boolean] whether or not to produce (strict) Dreck errors
     # @note *If* {#slop} is called, it must be called before this.
@@ -151,7 +151,7 @@ module KBSecret
     def guard
       yield
     rescue => e
-      STDERR.puts e.backtrace if @opts&.debug?
+      self.stderr.puts e.backtrace if @opts&.debug?
       die "#{e.to_s.capitalize}."
     end
 
@@ -159,7 +159,7 @@ module KBSecret
     # @param msg [String] the message to print
     # @return [void]
     def info(msg)
-      STDERR.puts "#{GREEN["Info"]}: #{msg}"
+      self.stderr.puts "#{GREEN["Info"]}: #{msg}"
     end
 
     # Print an information message, but only if verbose output has been enabled.
@@ -184,7 +184,7 @@ module KBSecret
     # @return [void]
     def warn(msg)
       return if @opts.no_warn?
-      STDERR.puts "#{YELLOW["Warning"]}: #{msg}"
+      self.stderr.puts "#{YELLOW["Warning"]}: #{msg}"
     end
 
     # Print an error message and terminate.
@@ -196,22 +196,38 @@ module KBSecret
       abort pretty
     end
 
-    class << self
-      # Print an error message and terminate.
-      # @param msg [String] the message to print
-      # @return [void]
-      # @note This method does not return!
-      def die(msg)
-        pretty = "#{RED["Fatal"]}: #{msg}"
-        abort pretty
-      end
+    # Print an error message and terminate.
+    # @param msg [String] the message to print
+    # @return [void]
+    # @note This method does not return!
+    def self.die(msg)
+      pretty = "#{RED["Fatal"]}: #{msg}"
+      abort pretty
+    end
 
-      # Finds a reasonable default field separator by checking the environment first
-      #  and then falling back to ":".
-      # @return [String] the field separator
-      def ifs
-        ENV["IFS"] || ":"
-      end
+    # Finds a reasonable default field separator by checking the environment first
+    #  and then falling back to ":".
+    # @return [String] the field separator
+    def self.ifs
+      ENV["IFS"] || ":"
+    end
+
+    # @return [IO] the IO object corresponding to the current standard input
+    # @note Internal `kbsecret` commands should use this, and not `STDIN`.
+    def self.stdin
+      $stdin
+    end
+
+    # @return [IO] the IO object corresponding to the current standard output
+    # @note Internal `kbsecret` commands should use this, and not `STDOUT`.
+    def self.stdout
+      $stdout
+    end
+
+    # @return [IO] the IO object corresponding to the current standard error
+    # @note Internal `kbsecret` commands should use this, and not `STDERR`.
+    def self.stderr
+      $stderr
     end
   end
 end

data/lib/kbsecret/version.rb

@@ -2,5 +2,5 @@
 
 module KBSecret
   # kbsecret's current version
-  VERSION = "1.3.0.pre.2"
+  VERSION = "1.3.0.pre.3"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 1.3.0.pre.2
+  version: 1.3.0.pre.3
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-31 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0.pre.alpha.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0.pre.alpha.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -227,12 +213,14 @@ files:
 - lib/kbsecret/cli.rb
 - lib/kbsecret/cli/command.rb
 - lib/kbsecret/cli/command/abstract.rb
+- lib/kbsecret/cli/command/commands.rb
 - lib/kbsecret/cli/command/conf.rb
 - lib/kbsecret/cli/command/cp.rb
 - lib/kbsecret/cli/command/dump_fields.rb
 - lib/kbsecret/cli/command/env.rb
 - lib/kbsecret/cli/command/generator.rb
 - lib/kbsecret/cli/command/generators.rb
+- lib/kbsecret/cli/command/help.rb
 - lib/kbsecret/cli/command/list.rb
 - lib/kbsecret/cli/command/login.rb
 - lib/kbsecret/cli/command/new.rb
@@ -243,6 +231,8 @@ files:
 - lib/kbsecret/cli/command/sessions.rb
 - lib/kbsecret/cli/command/stash_file.rb
 - lib/kbsecret/cli/command/todo.rb
+- lib/kbsecret/cli/command/types.rb
+- lib/kbsecret/cli/command/version.rb
 - lib/kbsecret/config.rb
 - lib/kbsecret/exceptions.rb
 - lib/kbsecret/generator.rb