qb 0.3.13 → 0.3.14

data/lib/qb/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Requirements
 # =======================================================================
 
@@ -32,101 +34,111 @@ module QB::CLI
   
   include SemanticLogger::Loggable
   
-  # Eigenclass (Singleton Class)
-  # ========================================================================
+  
+  # Constants
+  # ============================================================================
+  
+  # CLI args that common to all commands that enable debug output
   # 
-  class << self
-    
-    
-    # @todo Document ask method.
-    # 
-    # @param [type] arg_name
-    #   @todo Add name param description.
-    # 
-    # @return [return_type]
-    #   @todo Document return value.
-    # 
-    def ask name:,
-            description: nil,
-            type:,
-            default: NRSER::NO_ARG
-      puts
-        
-      value = loop do
-        
-        puts "Enter value for #{ name }"
-        
-        if description
-          puts description.indent
-        end
-        
-        puts "TYPE #{ type.to_s }".indent
-        
-        if default
-          puts "DEFAULT #{ default.to_s }".indent
-        end
-        
-        $stdout.write '> '
-        
-        value = gets.chomp
-        
-        QB.debug "User input", value
-        
-        if value == '' && default != NRSER::NO_ARG
-          puts <<-END.dedent
-            
-            Using default value #{ default.to_s }
-            
-          END
-          
-          return default
-        end
-        
-        begin
-          type.from_s value
-        rescue TypeError => e
-          puts <<-END.dedent
-            Input value #{ value.inspect } failed to satisfy type
-            
-                #{ type.to_s }
-            
-          END
-        else
-          break value
-        end
-        
-      end # loop
+  # @return [Array<String>]
+  # 
+  DEBUG_ARGS = ['-D', '--DEBUG'].freeze
+  
+  
+  def self.set_debug! args
+    if DEBUG_ARGS.any? {|arg| args.include? arg}
+      QB::Util::Logging.setup level: :debug
+      DEBUG_ARGS.each {|arg| args.delete arg}
+    end
+  end
+  
+
+  # @todo Document ask method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def self.ask name:,
+          description: nil,
+          type:,
+          default: NRSER::NO_ARG
+    puts
       
-      puts "Using value #{ value.inspect }"
+    value = loop do
       
-      return value
+      puts "Enter value for #{ name }"
       
-    end # #ask
-    
-    
-    def ask_for_option role:, option:
-      default = if role.defaults.key?(option.var_name)
-        role.defaults[option.var_name]
-      elsif option.required?
-        NRSER::NO_ARG
+      if description
+        puts description.indent
+      end
+      
+      puts "TYPE #{ type.to_s }".indent
+      
+      if default
+        puts "DEFAULT #{ default.to_s }".indent
+      end
+      
+      $stdout.write '> '
+      
+      value = gets.chomp
+      
+      QB.debug "User input", value
+      
+      if value == '' && default != NRSER::NO_ARG
+        puts <<-END.dedent
+          
+          Using default value #{ default.to_s }
+          
+        END
+        
+        return default
+      end
+      
+      begin
+        type.from_s value
+      rescue TypeError => e
+        puts <<-END.dedent
+          Input value #{ value.inspect } failed to satisfy type
+          
+              #{ type.to_s }
+          
+        END
       else
-        nil
+        break value
       end
       
-      ask name: option.name,
-          description: option.description,
-          default: default
-          # type:
-    end
+    end # loop
     
+    puts "Using value #{ value.inspect }"
     
-    def ask_for_options role:, options:
-      options.select { |opt| opt.value.nil? }.each { |option|
-        ask_for_option role: role, option: option
-      }
-    end # #ask_for_options
+    return value
     
+  end # .ask
+  
+  
+  def self.ask_for_option role:, option:
+    default = if role.defaults.key?(option.var_name)
+      role.defaults[option.var_name]
+    elsif option.required?
+      NRSER::NO_ARG
+    else
+      nil
+    end
     
-  end # class << self (Eigenclass)
+    ask name: option.name,
+        description: option.description,
+        default: default
+        # type:
+  end
+  
+  
+  def self.ask_for_options role:, options:
+    options.select { |opt| opt.value.nil? }.each { |option|
+      ask_for_option role: role, option: option
+    }
+  end # .ask_for_options
   
 end # module QB::CLI

data/lib/qb/options.rb

@@ -20,13 +20,13 @@ module QB
     # =======================================================================
     
     QB_DEFAULTS = {
-      'hosts' => ['localhost'],
+      'hosts' => ['localhost'].freeze,
       'facts' => true,
-      'print' => ['cmd'],
+      'print' => [].freeze,
       'verbose' => false,
       'run' => true,
       'ask' => false,
-    }
+    }.freeze
     
     # appended on the end of an `opts.on` call to create a newline after
     # the option (making the help output a bit easier to read)
@@ -210,7 +210,7 @@ module QB
                     end
                   }
                 }
-              else 
+              else
                 raise QB::Role::MetadataError,
                   "bad type for option #{ option.meta_name }: #{ option.meta['type'].inspect }"
               end
@@ -284,7 +284,7 @@ module QB
           options[option.cli_name] = option
         end
       end # each var
-    end # add 
+    end # add
     
     # destructively removes options from `@argv` and populates ansible, role,
     # and qb option hashes.
@@ -531,4 +531,4 @@ module QB
     # end protected
     
   end # Options
-end # QB
+end # QB

data/lib/qb/role/default_dir.rb

@@ -1,8 +1,8 @@
 ##
-# {QB::Role} methods for finding the default directory for 
+# {QB::Role} methods for finding the default directory for
 # running a role when one is not provided in the CLI.
 # 
-# Broken out from the main `//lib/qb/role.rb` file because it was starting to 
+# Broken out from the main `//lib/qb/role.rb` file because it was starting to
 # get long and unwieldy.
 # 
 ##
@@ -17,6 +17,7 @@ require 'pathname'
 
 # Deps
 # -----------------------------------------------------------------------
+require 'nrser'
 
 # Project / Package
 # -----------------------------------------------------------------------
@@ -25,7 +26,6 @@ require 'pathname'
 # Refinements
 # =======================================================================
 
-require 'nrser/refinements'
 using NRSER
 
 
@@ -46,11 +46,11 @@ class QB::Role
   # Gets the default `qb_dir` value, raising an error if the role doesn't
   # define how to get one or there is a problem getting it.
   # 
-  # It uses a "strategy" value found at the 'default_dir' key in the role's 
-  # QB metadata (in `<role_path>/meta/qb.yml` or returned by a 
+  # It uses a "strategy" value found at the 'default_dir' key in the role's
+  # QB metadata (in `<role_path>/meta/qb.yml` or returned by a
   # `<role_path>/meta/qb` executable).
   # 
-  # See the {file:doc/qb_roles/metadata/default_dir.md default_dir} 
+  # See the {file:doc/qb_roles/metadata/default_dir.md default_dir}
   # documentation for details on the accepted strategy values.
   # 
   # @param [String | Pathname] cwd:
@@ -65,7 +65,7 @@ class QB::Role
   #   The directory to target.
   # 
   # @raise
-  #   When we can't determine a directory due to role meta settings or target 
+  #   When we can't determine a directory due to role meta settings or target
   #   system state.
   # 
   def default_dir cwd, options
@@ -77,7 +77,7 @@ class QB::Role
       options: options
     
     default_dir_for(
-      value: self.meta['default_dir'],
+      strategy: self.meta['default_dir'],
       cwd: cwd,
       options: options
     ).to_pn
@@ -102,8 +102,8 @@ class QB::Role
     # @return [return_type]
     #   @todo Document return value.
     # 
-    def default_dir_for value:, cwd:, options:
-      case value
+    def default_dir_for strategy:, cwd:, options:
+      case strategy
       when nil
         # there is no get_dir info in meta/qb.yml, can't get the dir
         raise QB::UserInputError.new binding.erb <<-END
@@ -116,7 +116,7 @@ class QB::Role
           
               qb run <%= self.name %> DIRECTORY
           
-          or, if you are the developer of the <%= self.name %> role, set a 
+          or, if you are the developer of the <%= self.name %> role, set a
           non-null value for the 'default_dir' key in
           
               <%= self.meta_path %>
@@ -124,8 +124,8 @@ class QB::Role
         END
       
       when false
-        # this method should not get called when the value is false (an entire
-        # section is skipped in exe/qb when `default_dir = false`)
+        # this method should not get called when the strategy is `false` (an
+        # entire section is skipped in exe/qb when `default_dir = false`)
         raise QB::StateError.squished <<-END
           role does not use default directory (meta/qb.yml:default_dir = false)
         END
@@ -141,11 +141,11 @@ class QB::Role
       when Hash
         logger.debug "qb meta option is a Hash"
         
-        unless value.length == 1
-          raise "#{ meta_path.to_s }:default_dir invalid: #{ value.inspect }"
+        unless strategy.length == 1
+          raise "#{ meta_path.to_s }:default_dir invalid: #{ strategy.inspect }"
         end
         
-        hash_key, hash_value = value.first
+        hash_key, hash_value = strategy.first
         
         case hash_key
         when 'exe'
@@ -172,21 +172,21 @@ class QB::Role
           end
           
         when 'find_up'
-          filename = hash_value
+          rel_path = hash_value
           
-          unless filename.is_a? String
-            raise "find_up filename must be string, found #{ filename.inspect }"
+          unless rel_path.is_a? String
+            raise "find_up relative path or glob must be string, found #{ rel_path.inspect }"
           end
           
-          QB.debug "found 'find_up', looking for file named #{ filename }"
+          logger.debug "found 'find_up' strategy", rel_path: rel_path
           
-          QB::Util.find_up filename
+          cwd.to_pn.find_up! rel_path
         
         when 'from_role'
           # Get the value from another role, presumably one this role includes
           
           default_dir_for \
-            value: QB::Role.require( hash_value ).meta['default_dir'],
+            strategy: QB::Role.require( hash_value ).meta['default_dir'],
             cwd: cwd,
             options: options
           
@@ -200,9 +200,9 @@ class QB::Role
             
             contains an invalid default directory strategy
             
-                <%= value.pretty_inspect %>
+                <%= strategy.pretty_inspect %>
             
-            The key <%= hash_key.inspect %> does not correspond to a recognized 
+            The key <%= hash_key.inspect %> does not correspond to a recognized
             form.
             
             Valid forms are:
@@ -215,15 +215,15 @@ class QB::Role
         end
       
       when Array
-        value.try_find do |candidate|
-          default_dir_for value: candidate, cwd: cwd, options: options
+        strategy.try_find do |candidate|
+          default_dir_for strategy: candidate, cwd: cwd, options: options
         end
       
       else
         raise QB::Role::MetadataError.new binding.erb <<-END
-          bad default_dir value: <%= value %>
+          bad default_dir strategy: <%= strategy %>
         END
-      end # case value
+      end # case strategy
     end # .default_dir_for
     
   # end protected

data/lib/qb/util.rb

@@ -13,7 +13,7 @@ module QB
       string.split(/[\W_\-\/]+/).reject {|w| w.empty?}
     end # .words
     
-    # see if words from an input match words 
+    # see if words from an input match words
     def self.words_start_with? full_string, input
       # QB.debug "does #{ input } match #{ full_string }?"
       
@@ -84,6 +84,7 @@ module QB
       Pathname.new contracted
     end
     
+    
     # find `filename` in `from` or closest parent directory.
     # 
     # @param [String] filename
@@ -96,7 +97,7 @@ module QB
     #   When `true`, a {QB::FSStateError} will be raised if no file is found
     #   (default behavior).
     #   
-    #   This is something of a legacy behavior - I think it would be better 
+    #   This is something of a legacy behavior - I think it would be better
     #   to have {find_up} return `nil` in that case and add a `find_up!`
     #   method that raises on not found. But I'm not going to do it right now.
     # 

data/lib/qb/version.rb

@@ -4,7 +4,7 @@ module QB
   
   GEM_NAME = 'qb'
   
-  VERSION = "0.3.13"
+  VERSION = "0.3.14"
   
   MIN_ANSIBLE_VERSION = Gem::Version.new '2.1.2'
   

data/qb.gemspec

@@ -105,6 +105,8 @@ Gem::Specification.new do |spec|
   spec.homepage       = "https://github.com/nrser/qb"
   spec.license        = "MIT"
   
+  spec.required_ruby_version = '>= 2.3.0'
+  
   
   # Files
   # ============================================================================
@@ -160,6 +162,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep  %r{^#{ spec.bindir }/[^\.]},
                                         &File.method( :basename )
   
+  # Where that source be, standard `//lib` directory
   spec.require_paths = ["lib"]
   
   
@@ -169,20 +172,30 @@ Gem::Specification.new do |spec|
   # Development Dependencies
   # ----------------------------------------------------------------------------
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.7.0"
-  spec.add_development_dependency "yard", '~> 0.9.12'
-  spec.add_development_dependency "redcarpet"
-  spec.add_development_dependency "github-markup"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler",        '~> 1.16', '>= 1.16.1'
+  spec.add_development_dependency "rake",           '~> 12.3'
+  
+  # Testing with `rspec`
+  spec.add_development_dependency "rspec",          '~> 3.7'
+  
+  # Doc site generation with `yard`
+  spec.add_development_dependency "yard",           '~> 0.9.12'
+  
+  # These, along with `//.yardopts` config, are *supposed to* result in
+  # rendering markdown files and doc comments using
+  # GitHub-Flavored Markdown (GFM), though I'm not sure if it's totally working
+  spec.add_development_dependency "redcarpet",      '~> 3.4'
+  spec.add_development_dependency "github-markup",  '~> 1.6'
+  
+  # Nicer REPL experience
+  spec.add_development_dependency "pry",            '~> 0.10.4'
   
   
   # Runtime Dependencies
   # ----------------------------------------------------------------------------
   
   spec.add_dependency "cmds",             '~> 0.0', ">= 0.2.4"
-  spec.add_dependency "nrser",            '~> 0.0', ">= 0.0.30"
+  spec.add_dependency "nrser",            '~> 0.1', ">= 0.1.0"
   spec.add_dependency "nrser-extras",     '~> 0.0', ">= 0.0.3"
   spec.add_dependency "state_mate",       '~> 0.0', ">= 0.1.0"
   
@@ -199,7 +212,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'awesome_print',    '~> 1.8'
   
   # Ruby lib wrapping `git` binary system calls for use in {QB::Repo::Git}
-  spec.add_dependency 'git', '~> 1.3.0'
+  spec.add_dependency 'git',              '~> 1.3'
   
   
   # Development-Only Extra Metadata